com.pcloud.networking.protocol

Class ForwardingProtocolReader

java.lang.Object

com.pcloud.networking.protocol.ForwardingProtocolReader

All Implemented Interfaces:

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

public abstract class ForwardingProtocolReader
extends java.lang.Object
implements ProtocolReader

A ProtocolReader which forwards calls to another.

Useful for wrapping and subclassing without inheritance.

Field Summary

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

SCOPE_ARRAY, SCOPE_NONE, SCOPE_OBJECT

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

Methods inherited from class java.lang.Object

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

Method Detail

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

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

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

close

public void close()

Description copied from interface: ProtocolReader

Close the data source

Specified by:

close in interface ProtocolReader

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

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

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

newPeekingReader

public ProtocolReader newPeekingReader()

Description copied from interface: ProtocolReader

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