com.pcloud.networking.protocol

Interface ProtocolResponseReader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ProtocolReader

All Known Implementing Classes:

BytesReader, ForwardingProtocolResponseReader

public interface ProtocolResponseReader
extends ProtocolReader

A contract for a reader which can read data from a response

See Also:

ProtocolReader, BytesReader

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCOPE_DATA Indicated the reading is at the beginning of a response's attached byte data.
static int	SCOPE_RESPONSE Indicates the reader has begun reading a response
static int	UNKNOWN_SIZE A value to indicate the data content length is unknown

Fields inherited from interface com.pcloud.networking.protocol.ProtocolReader

SCOPE_ARRAY, SCOPE_NONE, SCOPE_OBJECT

Method Summary

Modifier and Type	Method and Description
long	beginResponse() Begin reading a response from the data source
long	dataContentLength() Get the length of the data that follows the response
boolean	endResponse() End reading a response from the data source
ProtocolResponseReader	newPeekingReader() Get a new instance peeking instance of this reader.
void	readData(okio.BufferedSink sink) Read the data after a response.
void	readData(java.io.OutputStream outputStream) Read the data after a response.

Methods inherited from interface com.pcloud.networking.protocol.ProtocolReader

beginArray, beginObject, close, currentScope, endArray, endObject, hasNext, peek, readBoolean, readNumber, readString, skipValue

Field Detail

SCOPE_RESPONSE

static final int SCOPE_RESPONSE

Indicates the reader has begun reading a response

See Also:

Constant Field Values

SCOPE_DATA

static final int SCOPE_DATA

Indicated the reading is at the beginning of a response's attached byte data.

See Also:

Constant Field Values

UNKNOWN_SIZE

static final int UNKNOWN_SIZE

A value to indicate the data content length is unknown

See Also:

Constant Field Values

Method Detail

beginResponse

long beginResponse()
            throws java.io.IOException

Begin reading a response from the data source

Returns:

the length of the response

Throws:

java.io.IOException - if the source has been exhausted prior to this operation

endResponse

boolean endResponse()
             throws java.io.IOException

End reading a response from the data source

Returns:

the boolean which indicates if the response has ended

Throws:

java.io.IOException - if the source has been exhausted prior to this operation

dataContentLength

long dataContentLength()

Get the length of the data that follows the response

Returns:

a long representing the data length

readData

void readData(okio.BufferedSink sink)
       throws java.io.IOException

Read the data after a response.

Use this method to red the data after reading a data-enriched response. Calling this method when the scope returned by ProtocolReader.currentScope() is not SCOPE_DATA will result in a IllegalStateException error.

Parameters:

sink - the non-null recipient of data

Throws:

java.io.IOException - or read or write errors.

java.lang.IllegalStateException - if called in scope other than @SCOPE_DATA

readData

void readData(java.io.OutputStream outputStream)
       throws java.io.IOException

Read the data after a response.

Use this method to red the data after reading a data-enriched response. Calling this method when the scope returned by ProtocolReader.currentScope() is not SCOPE_DATA will result in a IllegalStateException error.

Parameters:

outputStream - the non-null recipient of data

Throws:

java.io.IOException - or read or write errors.

java.lang.IllegalStateException - if called in scope other than @SCOPE_DATA

newPeekingReader

ProtocolResponseReader newPeekingReader()

Get a new instance peeking instance of this reader.

The peeking reader can read data without consuming it. It inherits all the fields of the current instance such as the data source and the scope. Any operations with the peeking reader will not exhaust the data source.

Specified by:

newPeekingReader in interface ProtocolReader

Returns:

a new instance of a peeking ProtocolReader