com.google.protobuf.CodedInputStream.StreamDecoder Class Reference

Inheritance diagram for com.google.protobuf.CodedInputStream.StreamDecoder:

Classes
interface	RefillCallback
class	SkippedDataSink

Public Member Functions
void	checkLastTagWas (final int value) throws InvalidProtocolBufferException
void	enableAliasing (boolean enabled)
int	getBytesUntilLimit ()
int	getLastTag ()
int	getTotalBytesRead ()
boolean	isAtEnd () throws IOException
void	popLimit (final int oldLimit)
int	pushLimit (int byteLimit) throws InvalidProtocolBufferException
boolean	readBool () throws IOException
byte[]	readByteArray () throws IOException
ByteBuffer	readByteBuffer () throws IOException
ByteString	readBytes () throws IOException
double	readDouble () throws IOException
int	readEnum () throws IOException
int	readFixed32 () throws IOException
long	readFixed64 () throws IOException
float	readFloat () throws IOException
void	readGroup (final int fieldNumber, final MessageLite.Builder builder, final ExtensionRegistryLite extensionRegistry) throws IOException
int	readInt32 () throws IOException
long	readInt64 () throws IOException
void	readMessage (final MessageLite.Builder builder, final ExtensionRegistryLite extensionRegistry) throws IOException
byte	readRawByte () throws IOException
byte[]	readRawBytes (final int size) throws IOException
int	readRawLittleEndian32 () throws IOException
long	readRawLittleEndian64 () throws IOException
int	readRawVarint32 () throws IOException
long	readRawVarint64 () throws IOException
int	readSFixed32 () throws IOException
long	readSFixed64 () throws IOException
int	readSInt32 () throws IOException
long	readSInt64 () throws IOException
String	readString () throws IOException
String	readStringRequireUtf8 () throws IOException
int	readTag () throws IOException
int	readUInt32 () throws IOException
long	readUInt64 () throws IOException
void	readUnknownGroup (final int fieldNumber, final MessageLite.Builder builder) throws IOException
void	resetSizeCounter ()
boolean	skipField (final int tag) throws IOException
boolean	skipField (final int tag, final CodedOutputStream output) throws IOException
void	skipMessage () throws IOException
void	skipMessage (CodedOutputStream output) throws IOException
void	skipRawBytes (final int size) throws IOException
Public Member Functions inherited from com.google.protobuf.CodedInputStream
final int	setRecursionLimit (final int limit)
final int	setSizeLimit (final int limit)

Private Member Functions
ByteString	readBytesSlowPath (final int size) throws IOException
byte[]	readRawBytesSlowPath (final int size, boolean ensureNoLeakedReferences) throws IOException
byte[]	readRawBytesSlowPathOneChunk (final int size) throws IOException
List< byte[]>	readRawBytesSlowPathRemainingChunks (int sizeLeft) throws IOException
void	recomputeBufferSizeAfterLimit ()
void	refillBuffer (int n) throws IOException
void	skipRawBytesSlowPath (final int size) throws IOException
void	skipRawVarint () throws IOException
void	skipRawVarintFastPath () throws IOException
void	skipRawVarintSlowPath () throws IOException
	StreamDecoder (final InputStream input, int bufferSize)
boolean	tryRefillBuffer (int n) throws IOException

Private Attributes
final byte[]	buffer
int	bufferSize
int	bufferSizeAfterLimit
int	currentLimit = Integer.MAX_VALUE
final InputStream	input
int	lastTag
int	pos
RefillCallback	refillCallback = null
int	totalBytesRetired

Additional Inherited Members
Static Public Member Functions inherited from com.google.protobuf.CodedInputStream
static int	decodeZigZag32 (final int n)
static long	decodeZigZag64 (final long n)
static CodedInputStream	newInstance (ByteBuffer buf)
static CodedInputStream	newInstance (final byte[] buf)
static CodedInputStream	newInstance (final byte[] buf, final int off, final int len)
static CodedInputStream	newInstance (final InputStream input)
static CodedInputStream	newInstance (final InputStream input, int bufferSize)
static CodedInputStream	newInstance (final Iterable< ByteBuffer > input)
static int	readRawVarint32 (final int firstByte, final InputStream input) throws IOException

Detailed Description

Implementation of CodedInputStream that uses an InputStream as the data source.

Definition at line 2025 of file CodedInputStream.java.

Constructor & Destructor Documentation

StreamDecoder()

com.google.protobuf.CodedInputStream.StreamDecoder.StreamDecoder ( final InputStream  input, int  bufferSize  )

inlineprivate

Definition at line 2046 of file CodedInputStream.java.

Member Function Documentation

checkLastTagWas()

void com.google.protobuf.CodedInputStream.StreamDecoder.checkLastTagWas ( final int  value ) throws InvalidProtocolBufferException

inline

Verifies that the last call to readTag() returned the given tag value. This is used to verify that a nested group ended with the correct end tag.

Exceptions

InvalidProtocolBufferException

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2072 of file CodedInputStream.java.

enableAliasing()

void com.google.protobuf.CodedInputStream.StreamDecoder.enableAliasing ( boolean  enabled )

inline

Enables ByteString aliasing of the underlying buffer, trading off on buffer pinning for data copies. Only valid for buffer-backed streams.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2650 of file CodedInputStream.java.

getBytesUntilLimit()

int com.google.protobuf.CodedInputStream.StreamDecoder.getBytesUntilLimit ( )

inline

Returns the number of bytes to be read before the current limit. If no limit is set, returns -1.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2695 of file CodedInputStream.java.

getLastTag()

int com.google.protobuf.CodedInputStream.StreamDecoder.getLastTag ( )

inline

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2079 of file CodedInputStream.java.

getTotalBytesRead()

int com.google.protobuf.CodedInputStream.StreamDecoder.getTotalBytesRead ( )

inline

The total bytes read up to the current position. Calling resetSizeCounter() resets this value to zero.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2710 of file CodedInputStream.java.

isAtEnd()

boolean com.google.protobuf.CodedInputStream.StreamDecoder.isAtEnd ( ) throws IOException

inline

Returns true if the stream has reached the end of the input. This is the case if either the end of the underlying input source has been reached or if the stream has reached a limit created using pushLimit(int).

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2705 of file CodedInputStream.java.

popLimit()

void com.google.protobuf.CodedInputStream.StreamDecoder.popLimit ( final int  oldLimit )

inline

Discards the current limit, returning to the previous limit.

Parameters

oldLimit

The old limit, as returned by pushLimit .

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2689 of file CodedInputStream.java.

pushLimit()

int com.google.protobuf.CodedInputStream.StreamDecoder.pushLimit ( int  byteLimit ) throws InvalidProtocolBufferException

inline

Sets

currentLimit 

to (current position) +

byteLimit 

. This is called when descending into a length-delimited embedded message.

Note that

pushLimit() 

does NOT affect how many bytes the

CodedInputStream 

reads from an underlying

InputStream 

when refreshing its buffer. If you need to prevent reading past a certain point in the underlying

InputStream 

(e.g. because you expect it to contain more data after the end of the message which you need to handle differently) then you must place a wrapper around your

InputStream 

which limits the amount of data that can be read from it.

Returns

the old limit.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2660 of file CodedInputStream.java.

readBool()

boolean com.google.protobuf.CodedInputStream.StreamDecoder.readBool ( ) throws IOException

inline

Read a

bool 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2245 of file CodedInputStream.java.

readByteArray()

byte [] com.google.protobuf.CodedInputStream.StreamDecoder.readByteArray ( ) throws IOException

inline

Read a

bytes 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2388 of file CodedInputStream.java.

readByteBuffer()

ByteBuffer com.google.protobuf.CodedInputStream.StreamDecoder.readByteBuffer ( ) throws IOException

inline

Read a

bytes 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2404 of file CodedInputStream.java.

readBytes()

ByteString com.google.protobuf.CodedInputStream.StreamDecoder.readBytes ( ) throws IOException

inline

Read a

bytes 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2372 of file CodedInputStream.java.

readBytesSlowPath()

ByteString com.google.protobuf.CodedInputStream.StreamDecoder.readBytesSlowPath ( final int  size ) throws IOException

inlineprivate

Like readBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0 || size == 0)

Definition at line 2971 of file CodedInputStream.java.

readDouble()

double com.google.protobuf.CodedInputStream.StreamDecoder.readDouble ( ) throws IOException

inline

Read a

double 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2210 of file CodedInputStream.java.

readEnum()

int com.google.protobuf.CodedInputStream.StreamDecoder.readEnum ( ) throws IOException

inline

Read an enum field value from the stream. Caller is responsible for converting the numeric value to an actual enum.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2428 of file CodedInputStream.java.

readFixed32()

int com.google.protobuf.CodedInputStream.StreamDecoder.readFixed32 ( ) throws IOException

inline

Read a

fixed32 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2240 of file CodedInputStream.java.

readFixed64()

long com.google.protobuf.CodedInputStream.StreamDecoder.readFixed64 ( ) throws IOException

inline

Read a

fixed64 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2235 of file CodedInputStream.java.

readFloat()

float com.google.protobuf.CodedInputStream.StreamDecoder.readFloat ( ) throws IOException

inline

Read a

float 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2215 of file CodedInputStream.java.

readGroup()

void com.google.protobuf.CodedInputStream.StreamDecoder.readGroup ( final int  fieldNumber, final MessageLite.Builder  builder, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

Read a

group 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2300 of file CodedInputStream.java.

readInt32()

int com.google.protobuf.CodedInputStream.StreamDecoder.readInt32 ( ) throws IOException

inline

Read an

int32 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2230 of file CodedInputStream.java.

readInt64()

long com.google.protobuf.CodedInputStream.StreamDecoder.readInt64 ( ) throws IOException

inline

Read an

int64 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2225 of file CodedInputStream.java.

readMessage()

void com.google.protobuf.CodedInputStream.StreamDecoder.readMessage ( final MessageLite.Builder  builder, final ExtensionRegistryLite  extensionRegistry  ) throws IOException

inline

Read an embedded message field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2339 of file CodedInputStream.java.

readRawByte()

byte com.google.protobuf.CodedInputStream.StreamDecoder.readRawByte ( ) throws IOException

inline

Read one byte from the input.

Exceptions

InvalidProtocolBufferException

The end of the stream or the current limit was reached.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2808 of file CodedInputStream.java.

readRawBytes()

byte [] com.google.protobuf.CodedInputStream.StreamDecoder.readRawBytes ( final int  size ) throws IOException

inline

Read a fixed size of bytes from the input.

Exceptions

InvalidProtocolBufferException

The end of the stream or the current limit was reached.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2816 of file CodedInputStream.java.

readRawBytesSlowPath()

byte [] com.google.protobuf.CodedInputStream.StreamDecoder.readRawBytesSlowPath ( final int  size, boolean  ensureNoLeakedReferences  ) throws IOException

inlineprivate

Exactly like readRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size > 0)

If ensureNoLeakedReferences is true, the value is guaranteed to have not escaped to untrusted code.

Definition at line 2834 of file CodedInputStream.java.

readRawBytesSlowPathOneChunk()

byte [] com.google.protobuf.CodedInputStream.StreamDecoder.readRawBytesSlowPathOneChunk ( final int  size ) throws IOException

inlineprivate

Attempts to read the data in one byte array when it's safe to do. Returns null if the size to read is too large and needs to be allocated in smaller chunks for security reasons.

Returns a byte[] that may have escaped to user code via InputStream APIs.

Definition at line 2880 of file CodedInputStream.java.

readRawBytesSlowPathRemainingChunks()

List<byte[]> com.google.protobuf.CodedInputStream.StreamDecoder.readRawBytesSlowPathRemainingChunks ( int  sizeLeft ) throws IOException

inlineprivate

Reads the remaining data in small chunks from the input stream.

Returns a byte[] that may have escaped to user code via InputStream APIs.

Definition at line 2938 of file CodedInputStream.java.

readRawLittleEndian32()

int com.google.protobuf.CodedInputStream.StreamDecoder.readRawLittleEndian32 ( ) throws IOException

inline

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

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2610 of file CodedInputStream.java.

readRawLittleEndian64()

long com.google.protobuf.CodedInputStream.StreamDecoder.readRawLittleEndian64 ( ) throws IOException

inline

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

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2627 of file CodedInputStream.java.

readRawVarint32()

int com.google.protobuf.CodedInputStream.StreamDecoder.readRawVarint32 ( ) throws IOException

inline

Read a raw Varint from the stream. If larger than 32 bits, discard the upper bits.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2455 of file CodedInputStream.java.

readRawVarint64()

long com.google.protobuf.CodedInputStream.StreamDecoder.readRawVarint64 ( ) throws IOException

inline

Read a raw Varint from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2524 of file CodedInputStream.java.

readSFixed32()

int com.google.protobuf.CodedInputStream.StreamDecoder.readSFixed32 ( ) throws IOException

inline

Read an

sfixed32 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2433 of file CodedInputStream.java.

readSFixed64()

long com.google.protobuf.CodedInputStream.StreamDecoder.readSFixed64 ( ) throws IOException

inline

Read an

sfixed64 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2438 of file CodedInputStream.java.

readSInt32()

int com.google.protobuf.CodedInputStream.StreamDecoder.readSInt32 ( ) throws IOException

inline

Read an

sint32 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2443 of file CodedInputStream.java.

readSInt64()

long com.google.protobuf.CodedInputStream.StreamDecoder.readSInt64 ( ) throws IOException

inline

Read an

sint64 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2448 of file CodedInputStream.java.

readString()

String com.google.protobuf.CodedInputStream.StreamDecoder.readString ( ) throws IOException

inline

Read a

string 

field value from the stream. If the stream contains malformed UTF-8, replace the offending bytes with the standard UTF-8 replacement character.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2250 of file CodedInputStream.java.

readStringRequireUtf8()

String com.google.protobuf.CodedInputStream.StreamDecoder.readStringRequireUtf8 ( ) throws IOException

inline

Read a

string 

field value from the stream. If the stream contains malformed UTF-8, throw exception InvalidProtocolBufferException.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2273 of file CodedInputStream.java.

readTag()

int com.google.protobuf.CodedInputStream.StreamDecoder.readTag ( ) throws IOException

inline

Attempt to read a field tag, returning zero if we have reached EOF. Protocol message parsers use this to read tags, since a protocol message may legally end wherever a tag occurs, and zero is not a valid tag number.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2056 of file CodedInputStream.java.

readUInt32()

int com.google.protobuf.CodedInputStream.StreamDecoder.readUInt32 ( ) throws IOException

inline

Read a

uint32 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2423 of file CodedInputStream.java.

readUInt64()

long com.google.protobuf.CodedInputStream.StreamDecoder.readUInt64 ( ) throws IOException

inline

Read a

uint64 

field value from the stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2220 of file CodedInputStream.java.

readUnknownGroup()

void com.google.protobuf.CodedInputStream.StreamDecoder.readUnknownGroup ( final int  fieldNumber, final MessageLite.Builder  builder  ) throws IOException

inline

Reads a

group 

field value from the stream and merges it into the given {}. deprecated 16.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2333 of file CodedInputStream.java.

recomputeBufferSizeAfterLimit()

void com.google.protobuf.CodedInputStream.StreamDecoder.recomputeBufferSizeAfterLimit ( )

inlineprivate

Definition at line 2676 of file CodedInputStream.java.

refillBuffer()

void com.google.protobuf.CodedInputStream.StreamDecoder.refillBuffer ( int  n ) throws IOException

inlineprivate

Reads more bytes from the input, making at least

n 

bytes available in the buffer. Caller must ensure that the requested space is not yet available, and that the requested space is less than BUFFER_SIZE.

Exceptions

InvalidProtocolBufferException

The end of the stream or the current limit was reached.

Definition at line 2728 of file CodedInputStream.java.

resetSizeCounter()

void com.google.protobuf.CodedInputStream.StreamDecoder.resetSizeCounter ( )

inline

Resets the current size counter to zero (see setSizeLimit(int)). Only valid for {}-backed streams.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2655 of file CodedInputStream.java.

skipField() [1/2]

boolean com.google.protobuf.CodedInputStream.StreamDecoder.skipField ( final int  tag ) throws IOException

inline

Reads and discards a single field, given its tag value.

Returns

false 

if the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returns

true 

.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2084 of file CodedInputStream.java.

skipField() [2/2]

boolean com.google.protobuf.CodedInputStream.StreamDecoder.skipField ( final int  tag, final CodedOutputStream  output  ) throws IOException

inline

Reads a single field and writes it to output in wire format, given its tag value.

Returns

false 

if the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returns

true 

.

Deprecated:

use

UnknownFieldSet 

or

UnknownFieldSetLite 

to skip to an output stream.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2111 of file CodedInputStream.java.

skipMessage() [1/2]

void com.google.protobuf.CodedInputStream.StreamDecoder.skipMessage ( ) throws IOException

inline

Reads and discards an entire message. This will read either until EOF or until an endgroup tag, whichever comes first.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2162 of file CodedInputStream.java.

skipMessage() [2/2]

void com.google.protobuf.CodedInputStream.StreamDecoder.skipMessage ( CodedOutputStream  output ) throws IOException

inline

Reads an entire message and writes it to output in wire format. This will read either until EOF or until an endgroup tag, whichever comes first.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 2172 of file CodedInputStream.java.

skipRawBytes()

void com.google.protobuf.CodedInputStream.StreamDecoder.skipRawBytes ( final int  size ) throws IOException

inline

Reads and discards

size 

bytes.

Exceptions

InvalidProtocolBufferException

The end of the stream or the current limit was reached.

Reimplemented from com.google.protobuf.CodedInputStream.

Definition at line 3011 of file CodedInputStream.java.

skipRawBytesSlowPath()

void com.google.protobuf.CodedInputStream.StreamDecoder.skipRawBytesSlowPath ( final int  size ) throws IOException

inlineprivate

Exactly like skipRawBytes, but caller must have already checked the fast path: (size <= (bufferSize - pos) && size >= 0)

Definition at line 3024 of file CodedInputStream.java.

skipRawVarint()

void com.google.protobuf.CodedInputStream.StreamDecoder.skipRawVarint ( ) throws IOException

inlineprivate

Definition at line 2497 of file CodedInputStream.java.

skipRawVarintFastPath()

void com.google.protobuf.CodedInputStream.StreamDecoder.skipRawVarintFastPath ( ) throws IOException

inlineprivate

Definition at line 2505 of file CodedInputStream.java.

skipRawVarintSlowPath()

void com.google.protobuf.CodedInputStream.StreamDecoder.skipRawVarintSlowPath ( ) throws IOException

inlineprivate

Definition at line 2514 of file CodedInputStream.java.

tryRefillBuffer()

boolean com.google.protobuf.CodedInputStream.StreamDecoder.tryRefillBuffer ( int  n ) throws IOException

inlineprivate

Tries to read more bytes from the input, making at least

n 

bytes available in the buffer. Caller must ensure that the requested space is not yet available, and that the requested space is less than BUFFER_SIZE.

Returns

true 

If the bytes could be made available;

false 

1. Current at the end of the stream 2. The current limit was reached 3. The total size limit was reached

Definition at line 2748 of file CodedInputStream.java.

Member Data Documentation

buffer

final byte [] com.google.protobuf.CodedInputStream.StreamDecoder.buffer

private

Definition at line 2027 of file CodedInputStream.java.

bufferSize

int com.google.protobuf.CodedInputStream.StreamDecoder.bufferSize

private

bufferSize represents how many bytes are currently filled in the buffer

Definition at line 2029 of file CodedInputStream.java.

bufferSizeAfterLimit

int com.google.protobuf.CodedInputStream.StreamDecoder.bufferSizeAfterLimit

private

Definition at line 2031 of file CodedInputStream.java.

currentLimit

int com.google.protobuf.CodedInputStream.StreamDecoder.currentLimit = Integer.MAX_VALUE

private

The absolute position of the end of the current message.

Definition at line 2044 of file CodedInputStream.java.

input

final InputStream com.google.protobuf.CodedInputStream.StreamDecoder.input

private

Definition at line 2026 of file CodedInputStream.java.

lastTag

int com.google.protobuf.CodedInputStream.StreamDecoder.lastTag

private

Definition at line 2033 of file CodedInputStream.java.

pos

int com.google.protobuf.CodedInputStream.StreamDecoder.pos

private

Definition at line 2032 of file CodedInputStream.java.

refillCallback

RefillCallback com.google.protobuf.CodedInputStream.StreamDecoder.refillCallback = null

private

Definition at line 2718 of file CodedInputStream.java.

totalBytesRetired

int com.google.protobuf.CodedInputStream.StreamDecoder.totalBytesRetired

private

The total number of bytes read before the current buffer. The total bytes read up to the current position can be computed as

totalBytesRetired + pos 

. This value may be negative if reading started in the middle of the current buffer (e.g. if the constructor that takes a byte array and an offset was used).

Definition at line 2041 of file CodedInputStream.java.

---

The documentation for this class was generated from the following file:

• CodedInputStream.java