com.pcloud.networking.client

Class ResponseBody

java.lang.Object

com.pcloud.networking.client.ResponseBody

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class ResponseBody
extends java.lang.Object
implements java.io.Closeable

An interface for the response body of a network call

See Also:

Response, ResponseData, ProtocolReader

Constructor Summary

Constructors

Constructor and Description
ResponseBody()

Method Summary

Modifier and Type	Method and Description
abstract long	contentLength() Returns the length of the content in this ResponseBody
abstract ResponseData	data() Returns the ResponseData for this ResponseBody
abstract Endpoint	endpoint() Returns the source Endpoint for this ResponseBody
abstract ProtocolReader	reader() Returns the ProtocolReader which is able to read this ResponseBody
java.lang.String	toString()
java.util.Map<java.lang.String,?>	toValues() Reads the data from the RequestBody and constructs a Map with all the data
byte[]	valuesByteArray() Deprecated. See valuesBytes()
okio.ByteString	valuesBytes() Deprecated. The one-shot stream of data being held by a ResponseBody needs to be decoded by a ProtocolReader which is already configured and ready for reading. The method brings some behavior ambiguity in cases where the stream may be partially consumed through the exposed ProtocolReader.
abstract void	writeTo(okio.BufferedSink sink) Deprecated. The one-shot stream of data being held by a ResponseBody needs to be decoded by a ProtocolReader which is already configured and ready for reading. The method brings some behavior ambiguity in cases where the stream may be partially consumed through the exposed ProtocolReader. *

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.io.Closeable

close

Constructor Detail

ResponseBody

public ResponseBody()

Method Detail

reader

public abstract ProtocolReader reader()

Returns the ProtocolReader which is able to read this ResponseBody

Returns:

A reference to the ProtocolReader which is able to read the RequestBody

valuesBytes

@Deprecated
public okio.ByteString valuesBytes()
                                         throws java.io.IOException

Deprecated. The one-shot stream of data being held by a ResponseBody needs to be decoded by a ProtocolReader which is already configured and ready for reading. The method brings some behavior ambiguity in cases where the stream may be partially consumed through the exposed ProtocolReader.

Consume the body content as an immutable ByteString

Note that the method will read an entire response body in memory, which potentially may cause an OutOfMemoryError

Returns:

a ByteString with the bytes of the body

Throws:

java.io.IOException - on failed IO operations

java.lang.IllegalStateException - if the response is already partially read * through the exposed ProtocolReader.

valuesByteArray

@Deprecated
public final byte[] valuesByteArray()
                                          throws java.io.IOException

Deprecated. See valuesBytes()

Return the body content as a byte array

Note that the method will read an entire response body in memory, which potentially may cause an OutOfMemoryError

Returns:

a byte array with the bytes of the body

Throws:

java.io.IOException - on failed IO operations

toValues

public final java.util.Map<java.lang.String,?> toValues()
                                                 throws java.io.IOException

Reads the data from the RequestBody and constructs a Map with all the data

Returns:

A Map with all the data from this ResponseBody

Throws:

java.io.IOException - on failed IO operations

contentLength

public abstract long contentLength()

Returns the length of the content in this ResponseBody

Returns:

The length of the content in this ResponseBody

data

public abstract ResponseData data()
                           throws java.io.IOException

Returns the ResponseData for this ResponseBody

Returns:

A reference to the ResponseData for this ResponseBody

Throws:

java.io.IOException - on failed IO operations

endpoint

public abstract Endpoint endpoint()

Returns the source Endpoint for this ResponseBody

Returns:

non-null Endpoint

writeTo

@Deprecated
public abstract void writeTo(okio.BufferedSink sink)
                                   throws java.io.IOException

Deprecated. The one-shot stream of data being held by a ResponseBody needs to be decoded by a ProtocolReader which is already configured and ready for reading. The method brings some behavior ambiguity in cases where the stream may be partially consumed through the exposed ProtocolReader. *

Write the body content to a BufferedSink

Parameters:

sink - the receiver of the data

Throws:

java.io.IOException - on failed IO operations

java.lang.IllegalStateException - if the response is already partially read through the exposed ProtocolReader.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object