com.pcloud.networking.protocol

Interface ProtocolReader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

ProtocolResponseReader

All Known Implementing Classes:

BytesReader, ForwardingProtocolReader, ForwardingProtocolResponseReader

public interface ProtocolReader
extends java.lang.AutoCloseable, java.io.Closeable

A contract for an object capable of reading serialized data from a data source.

See Also:

BytesReader, ValueReader

Field Summary

Fields

Modifier and Type	Field and Description
static int	SCOPE_ARRAY Indicates the reader is currently reading an array from the data source
static int	SCOPE_NONE Indicates the reader has either not begun reading or has finished reading all the data and is currently not reading anything
static int	SCOPE_OBJECT Indicates the reader is currently reading an object from the data source

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
void	close() Close the data source
int	currentScope() Get the current scope of the reader
void	endArray() End reading an array from the source
void	endObject() End reading an object from the source
boolean	hasNext() Check if the source has more data to read
ProtocolReader	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
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

Field Detail

SCOPE_NONE

static final int SCOPE_NONE

Indicates the reader has either not begun reading or has finished reading all the data and is currently not reading anything

See Also:

Constant Field Values

SCOPE_OBJECT

static final int SCOPE_OBJECT

Indicates the reader is currently reading an object from the data source

See Also:

Constant Field Values

SCOPE_ARRAY

static final int SCOPE_ARRAY

Indicates the reader is currently reading an array from the data source

See Also:

Constant Field Values

Method Detail

currentScope

int currentScope()

Get the current scope of the reader

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

Returns:

a constant integer representing the current scope of the reader

peek

TypeToken peek()
        throws java.io.IOException

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

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

beginObject

void beginObject()
          throws java.io.IOException

Begin reading an object from the source

Throws:

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

beginArray

void beginArray()
         throws java.io.IOException

Begin reading an array from the source

Throws:

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

endArray

void endArray()
       throws java.io.IOException

End reading an array from the source

Throws:

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

endObject

void endObject()
        throws java.io.IOException

End reading an object from the source

Throws:

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

readBoolean

boolean readBoolean()
             throws java.io.IOException

Read a boolean value from the source

Returns:

the value of the boolean being read

Throws:

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

readString

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

Read a String from the source

Returns:

the String being read

Throws:

java.io.IOException - if the source is exhausted

readNumber

long readNumber()
         throws java.io.IOException

Read a number from the source

Returns:

a long with the value of the number being read

Throws:

java.io.IOException - if the source is exhausted

close

void close()

Close the data source

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

hasNext

boolean hasNext()
         throws java.io.IOException

Check if the source has more data to read

Returns:

true if there are bytes to read, false otherwise

Throws:

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

skipValue

void skipValue()
        throws java.io.IOException

Consume and discard the next value

Throws:

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

newPeekingReader

ProtocolReader 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.

Returns:

a new instance of a peeking ProtocolReader