com.pcloud.networking.protocol

Class BytesReader

java.lang.Object

com.pcloud.networking.protocol.BytesReader

All Implemented Interfaces:

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

public class BytesReader
extends java.lang.Object
implements ProtocolResponseReader

A reader for pCloud's binary data protocol

An implementation of ProtocolResponseReader which can read data encoded in pCloud's binary protocol from a stream of bytes in pull-based fashion with minimal overhead.

The implementation can be reused for reading multiple responses from a byte source, as long as they are read completely.

See Also:

ProtocolReader, ProtocolResponseReader

Field Summary

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

SCOPE_DATA, SCOPE_RESPONSE, UNKNOWN_SIZE

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

SCOPE_ARRAY, SCOPE_NONE, SCOPE_OBJECT

Constructor Summary

Constructors

Constructor and Description
BytesReader(okio.BufferedSource bufferedSource) Create a BytesReader instance

Method Summary

Modifier and Type	Method and Description
void	beginArray() Begin reading an array from the source
void	beginObject() Begin reading an object from the source
long	beginResponse() Begin reading a response from the data source
void	close() Close the BufferedSource
int	currentScope() Get the current scope of the reader
long	dataContentLength() Get the length of the data that follows the response
void	endArray() End reading an array from the source
void	endObject() End reading an object from the source
boolean	endResponse() End reading a response from the data source
boolean	hasNext() Check if the source has more data to read
ProtocolResponseReader	newPeekingReader() Get a new instance peeking instance of this reader.
TypeToken	peek() Peek the data and check what is the type of the data that follows
boolean	readBoolean() Read a boolean value from the source
void	readData(okio.BufferedSink sink) Read the data after a response.
void	readData(java.io.OutputStream outputStream) Read the data after a response.
long	readNumber() Read a number from the source
java.lang.String	readString() Read a String from the source
void	skipValue() Consume and discard the next value

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesReader

public BytesReader(okio.BufferedSource bufferedSource)

Create a BytesReader instance

Parameters:

bufferedSource - a BufferedSource to read the data from

Throws:

java.lang.IllegalArgumentException - on a null BufferedSource argument

Method Detail

peek

public TypeToken peek()
               throws java.io.IOException

Description copied from interface: ProtocolReader

Peek the data and check what is the type of the data that follows

Return values can be TypeToken.BEGIN_OBJECT, TypeToken.BEGIN_ARRAY, TypeToken.END_OBJECT, TypeToken.END_ARRAY, TypeToken.STRING, TypeToken.BOOLEAN, TypeToken.NUMBER

Specified by:

peek in interface ProtocolReader

Returns:

A TypeToken constant representing the type of data that follows

Throws:

java.io.IOException - if the source is exhausted before the next bytes can be read

See Also:

TypeToken

beginResponse

public long beginResponse()
                   throws java.io.IOException

Description copied from interface: ProtocolResponseReader

Begin reading a response from the data source

Specified by:

beginResponse in interface ProtocolResponseReader

Returns:

the length of the response

Throws:

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

endResponse

public boolean endResponse()
                    throws java.io.IOException

Description copied from interface: ProtocolResponseReader

End reading a response from the data source

Specified by:

endResponse in interface ProtocolResponseReader

Returns:

the boolean which indicates if the response has ended

Throws:

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

beginObject

public void beginObject()
                 throws java.io.IOException

Description copied from interface: ProtocolReader

Begin reading an object from the source

Specified by:

beginObject in interface ProtocolReader

Throws:

java.io.IOException - if the source has been exhausted

beginArray

public void beginArray()
                throws java.io.IOException

Description copied from interface: ProtocolReader

Begin reading an array from the source

Specified by:

beginArray in interface ProtocolReader

Throws:

java.io.IOException - if the source has been exhausted

endArray

public void endArray()
              throws java.io.IOException

Description copied from interface: ProtocolReader

End reading an array from the source

Specified by:

endArray in interface ProtocolReader

Throws:

java.io.IOException - if the source has been exhausted

endObject

public void endObject()
               throws java.io.IOException

Description copied from interface: ProtocolReader

End reading an object from the source

Specified by:

endObject in interface ProtocolReader

Throws:

java.io.IOException - if the source has been exhausted

readBoolean

public boolean readBoolean()
                    throws java.io.IOException

Description copied from interface: ProtocolReader

Read a boolean value from the source

Specified by:

readBoolean in interface ProtocolReader

Returns:

the value of the boolean being read

Throws:

java.io.IOException - if the source has been exhausted

readString

public java.lang.String readString()
                            throws java.io.IOException

Description copied from interface: ProtocolReader

Read a String from the source

Specified by:

readString in interface ProtocolReader

Returns:

the String being read

Throws:

java.io.IOException - if the source is exhausted

readNumber

public long readNumber()
                throws java.io.IOException

Description copied from interface: ProtocolReader

Read a number from the source

Specified by:

readNumber in interface ProtocolReader

Returns:

a long with the value of the number being read

Throws:

java.io.IOException - if the source is exhausted

hasNext

public boolean hasNext()
                throws java.io.IOException

Description copied from interface: ProtocolReader

Check if the source has more data to read

Specified by:

hasNext in interface ProtocolReader

Returns:

true if there are bytes to read, false otherwise

Throws:

java.io.IOException - if the source has been exhausted

dataContentLength

public long dataContentLength()

Description copied from interface: ProtocolResponseReader

Get the length of the data that follows the response

Specified by:

dataContentLength in interface ProtocolResponseReader

Returns:

a long representing the data length

readData

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

Description copied from interface: ProtocolResponseReader

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 ProtocolResponseReader.SCOPE_DATA will result in a IllegalStateException error.

Specified by:

readData in interface ProtocolResponseReader

Parameters:

outputStream - the non-null recipient of data

Throws:

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

readData

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

Description copied from interface: ProtocolResponseReader

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 ProtocolResponseReader.SCOPE_DATA will result in a IllegalStateException error.

Specified by:

readData in interface ProtocolResponseReader

Parameters:

sink - the non-null recipient of data

Throws:

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

newPeekingReader

public ProtocolResponseReader newPeekingReader()

Description copied from interface: ProtocolResponseReader

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

Specified by:

newPeekingReader in interface ProtocolResponseReader

Returns:

a new instance of a peeking ProtocolReader

skipValue

public void skipValue()
               throws java.io.IOException

Description copied from interface: ProtocolReader

Consume and discard the next value

Specified by:

skipValue in interface ProtocolReader

Throws:

java.io.IOException - if the source has been exhausted

currentScope

public int currentScope()

Description copied from interface: ProtocolReader

Get the current scope of the reader

Return values can be ProtocolReader.SCOPE_NONE, ProtocolReader.SCOPE_OBJECT, ProtocolReader.SCOPE_ARRAY, ProtocolResponseReader.SCOPE_RESPONSE

Specified by:

currentScope in interface ProtocolReader

Returns:

a constant integer representing the current scope of the reader

close

public void close()

Close the BufferedSource

Specified by:

close in interface ProtocolReader

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable