com.squareup.wire

Class ProtoReader

java.lang.Object

com.squareup.wire.ProtoReader

public final class ProtoReader
extends Object

Reads and decodes protocol message fields.

Constructor Summary

Constructors

Constructor and Description
ProtoReader(okio.BufferedSource source)

Method Summary

Modifier and Type	Method and Description
long	beginMessage() Begin a nested message.
void	endMessage(long token) End a length-delimited nested message.
int	nextTag() Reads and returns the next tag of the message, or -1 if there are no further tags.
FieldEncoding	peekFieldEncoding() Returns the encoding of the next field value.
okio.ByteString	readBytes() Reads a bytes field value from the stream.
int	readFixed32() Reads a 32-bit little-endian integer from the stream.
long	readFixed64() Reads a 64-bit little-endian integer from the stream.
String	readString() Reads a string field value from the stream.
int	readVarint32() Reads a raw varint from the stream.
long	readVarint64() Reads a raw varint up to 64 bits in length from the stream.
void	skip() Skips the current field's value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtoReader

public ProtoReader(okio.BufferedSource source)

Method Detail

beginMessage

public long beginMessage()
                  throws IOException

Begin a nested message. A call to this method will restrict the reader so that nextTag() returns -1 when the message is complete. An accompanying call to endMessage(long) must then occur with the opaque token returned from this method.

Throws:

IOException

endMessage

public void endMessage(long token)
                throws IOException

End a length-delimited nested message. Calls to this method must be symmetric with calls to beginMessage().

Parameters:

token - value returned from the corresponding call to beginMessage().

Throws:

IOException

nextTag

public int nextTag()
            throws IOException

Reads and returns the next tag of the message, or -1 if there are no further tags. Use peekFieldEncoding() after calling this method to query its encoding. This silently skips groups.

Throws:

IOException

peekFieldEncoding

public FieldEncoding peekFieldEncoding()

Returns the encoding of the next field value. nextTag() must be called before this method.

skip

public void skip()
          throws IOException

Skips the current field's value. This is only safe to call immediately following a call to nextTag().

Throws:

IOException

readBytes

public okio.ByteString readBytes()
                          throws IOException

Reads a bytes field value from the stream. The length is read from the stream prior to the actual data.

Throws:

IOException

readString

public String readString()
                  throws IOException

Reads a string field value from the stream.

Throws:

IOException

readVarint32

public int readVarint32()
                 throws IOException

Reads a raw varint from the stream. If larger than 32 bits, discard the upper bits.

Throws:

IOException

readVarint64

public long readVarint64()
                  throws IOException

Reads a raw varint up to 64 bits in length from the stream.

Throws:

IOException

readFixed32

public int readFixed32()
                throws IOException

Reads a 32-bit little-endian integer from the stream.

Throws:

IOException

readFixed64

public long readFixed64()
                 throws IOException

Reads a 64-bit little-endian integer from the stream.

Throws:

IOException