Class CodedInputStream.ArrayDecoder

java.lang.Object

com.google.protobuf.CodedInputStream

com.google.protobuf.CodedInputStream.ArrayDecoder

Direct Known Subclasses:

CodedInputStream.ArrayDecoderNewVarintAllCases, CodedInputStream.ArrayDecoderNewVarintTagsLengthsOnly, CodedInputStream.ArrayDecoderOldVarint

Enclosing class:

CodedInputStream

private abstract static class CodedInputStream.ArrayDecoder
extends CodedInputStream

A CodedInputStream implementation that uses a backing array as the input.

Nested Class Summary

Nested classes/interfaces inherited from class CodedInputStream

CodedInputStream.VarintExperiment

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	buffer
private final int	bufferLimit	The limit of the buffer this decoder is permitted to read.
private int	currentLimit	The unclamped absolute limit of the end of the current message (as an absolute index in the buffer).
private boolean	enableAliasing
private final boolean	immutable
private int	lastTag
private int	limit	The clamped reading limit, guaranteed to be invalid input: '<'= bufferLimit.
private int	pos
private int	startPos

Fields inherited from class CodedInputStream

groupDepth, messageDepth, recursionLimit, sizeLimit, wrapper

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ArrayDecoder(byte[] buffer, int offset, int len, boolean immutable)

Method Summary

Modifier and Type	Method	Description
void	checkLastTagWas(int value)	Verifies that the last call to readTag() returned the given tag value.
void	enableAliasing(boolean enabled)	Enables aliasing of the underlying input buffer for buffer-backed decoders.
int	getBytesUntilLimit()	Returns the number of bytes to be read before the current limit.
int	getLastTag()
int	getTotalBytesRead()	The total bytes read up to the current position.
boolean	isAtEnd()	Returns true if the stream has reached the end of the input.
void	popLimit(int oldLimit)	Discards the current limit, returning to the previous limit.
private void	popLimitAfterMessage(int oldLimit)
int	pushLimit(int byteLimit)	Sets currentLimit to (current position) + byteLimit.
private int	pushLimitBeforeMessage()
boolean	readBool()	Read a bool field value from the stream.
byte[]	readByteArray()	Read a bytes field value from the stream.
ByteBuffer	readByteBuffer()	Read a bytes field value from the stream.
ByteString	readBytes()	Read a bytes field value from the stream.
private ByteString	readBytesInternal(boolean requireUtf8)
double	readDouble()	Read a double field value from the stream.
int	readEnum()	Read an enum field value from the stream.
int	readFixed32()	Read a fixed32 field value from the stream.
long	readFixed64()	Read a fixed64 field value from the stream.
float	readFloat()	Read a float field value from the stream.
void	readGroup(int fieldNumber, MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry)	Read a group field value from the stream.
<T extends MessageLite> T	readGroup(int fieldNumber, Parser<T> parser, ExtensionRegistryLite extensionRegistry)	Read a group field value from the stream.
int	readInt32()	Read an int32 field value from the stream.
long	readInt64()	Read an int64 field value from the stream.
void	readMessage(MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry)	Read an embedded message field value from the stream.
<T extends MessageLite> T	readMessage(Parser<T> parser, ExtensionRegistryLite extensionRegistry)	Read an embedded message field value from the stream.
byte	readRawByte()	Read one byte from the input.
byte[]	readRawBytes(int length)	Read a fixed size of bytes from the input.
int	readRawLittleEndian32()	Read a 32-bit little-endian integer from the stream.
long	readRawLittleEndian64()	Read a 64-bit little-endian integer from the stream.
int	readRawVarint32()	Read a raw Varint from the stream.
protected abstract int	readRawVarint32Expected10BytesMax()	Temporary shim to enable new varint experiment.
protected abstract int	readRawVarint32Expected5BytesMax()	Temporary shim to enable new varint experiment.
protected int	readRawVarint32New()
private int	readRawVarint32NewFast()	Fast case: the limit is not checked here, this may read in the buffer past the limit, and may throw an IndexOutOfBoundsException if the varint runs off the end of the buffer.
protected int	readRawVarint32Old()
long	readRawVarint64()	Read a raw Varint from the stream.
(package private) long	readRawVarint64SlowPath()	Variant of readRawVarint64 for when uncomfortably close to the limit.
int	readSFixed32()	Read an sfixed32 field value from the stream.
long	readSFixed64()	Read an sfixed64 field value from the stream.
int	readSInt32()	Read an sint32 field value from the stream.
long	readSInt64()	Read an sint64 field value from the stream.
String	readString()	Read a string field value from the stream.
String	readStringRequireUtf8()	Read a string field value from the stream.
int	readTag()	Attempt to read a field tag, returning zero if we have reached EOF.
int	readUInt32()	Read a uint32 field value from the stream.
long	readUInt64()	Read a uint64 field value from the stream.
void	readUnknownGroup(int fieldNumber, MessageLite.Builder builder)	Deprecated.
void	resetSizeCounter()	Resets the current size counter to zero (see CodedInputStream.setSizeLimit(int)).
private void	setCurrentLimit(int newLimit)	Sets the active message boundary (currentLimit) and clamps the reading limit ( limit).
boolean	skipField(int tag)	Reads and discards a single field, given its tag value.
boolean	skipField(int tag, CodedOutputStream output)	Reads a single field and writes it to output in wire format, given its tag value.
void	skipRawBytes(int length)	Reads and discards size bytes.
private void	skipRawVarint()
private void	skipRawVarintFastPath()
private void	skipRawVarintSlowPath()
int	streamRawBytes(byte[] bytes, int offset, int length)	Read up to length bytes into bytes starting at offset.

Methods inherited from class CodedInputStream

checkRecursionLimit, checkValidEndTag, decodeZigZag32, decodeZigZag64, discardUnknownFields, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, newInstance, readPrimitiveField, readRawVarint32, readRawVarint32, readString, setRecursionLimit, setSizeLimit, setVarintExperiment, shouldDiscardUnknownFields, skipMessage, skipMessage, unsetDiscardUnknownFields

Methods inherited from class Object

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

Field Details

buffer

private final byte[] buffer

bufferLimit

private final int bufferLimit

The limit of the buffer this decoder is permitted to read. Usually this is equal to buffer.length but can be smaller if we are asked to parse a slice of a larger array.

immutable

private final boolean immutable

limit

private int limit

The clamped reading limit, guaranteed to be invalid input: '<'= bufferLimit. Reading stops when pos reaches this index. This is the clamped version of currentLimit.

pos

private int pos

startPos

private int startPos

lastTag

private int lastTag

enableAliasing

private boolean enableAliasing

currentLimit

private int currentLimit

The unclamped absolute limit of the end of the current message (as an absolute index in the buffer). This can exceed the physical buffer capacity (e.g., when it is Integer.MAX_VALUE indicating no limit, or if the input is corrupt and specifies a length extending beyond bufferLimit).

Note: when this value is modified, setCurrentLimit() must be called to ensure limit is updated (clamped) accordingly.

Constructor Details

ArrayDecoder

private ArrayDecoder(byte[] buffer,
 int offset,
 int len,
 boolean immutable)

Method Details

readTag

public int readTag()
            throws IOException

Description copied from class: CodedInputStream

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.

Specified by:

readTag in class CodedInputStream

Throws:

IOException

checkLastTagWas

public void checkLastTagWas(int value)
                     throws InvalidProtocolBufferException

Description copied from class: CodedInputStream

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.

Specified by:

checkLastTagWas in class CodedInputStream

Throws:

InvalidProtocolBufferException - value does not match the last tag.

getLastTag

public int getLastTag()

Specified by:

getLastTag in class CodedInputStream

skipField

public boolean skipField(int tag)
                  throws IOException

Description copied from class: CodedInputStream

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

Specified by:

skipField in class CodedInputStream

Returns:

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

Throws:

IOException

skipField

public boolean skipField(int tag,
 CodedOutputStream output)
                  throws IOException

Description copied from class: CodedInputStream

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

Specified by:

skipField in class CodedInputStream

Returns:

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

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Description copied from class: CodedInputStream

Read a double field value from the stream.

Specified by:

readDouble in class CodedInputStream

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Description copied from class: CodedInputStream

Read a float field value from the stream.

Specified by:

readFloat in class CodedInputStream

Throws:

IOException

readUInt64

public long readUInt64()
                throws IOException

Description copied from class: CodedInputStream

Read a uint64 field value from the stream.

Specified by:

readUInt64 in class CodedInputStream

Throws:

IOException

readInt64

public long readInt64()
               throws IOException

Description copied from class: CodedInputStream

Read an int64 field value from the stream.

Specified by:

readInt64 in class CodedInputStream

Throws:

IOException

readInt32

public int readInt32()
              throws IOException

Description copied from class: CodedInputStream

Read an int32 field value from the stream.

Specified by:

readInt32 in class CodedInputStream

Throws:

IOException

readFixed64

public long readFixed64()
                 throws IOException

Description copied from class: CodedInputStream

Read a fixed64 field value from the stream.

Specified by:

readFixed64 in class CodedInputStream

Throws:

IOException

readFixed32

public int readFixed32()
                throws IOException

Description copied from class: CodedInputStream

Read a fixed32 field value from the stream.

Specified by:

readFixed32 in class CodedInputStream

Throws:

IOException

readBool

public boolean readBool()
                 throws IOException

Description copied from class: CodedInputStream

Read a bool field value from the stream.

Specified by:

readBool in class CodedInputStream

Throws:

IOException

readString

public String readString()
                  throws IOException

Description copied from class: CodedInputStream

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.

Specified by:

readString in class CodedInputStream

Throws:

IOException

readStringRequireUtf8

public String readStringRequireUtf8()
                             throws IOException

Description copied from class: CodedInputStream

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

Specified by:

readStringRequireUtf8 in class CodedInputStream

Throws:

IOException

readGroup

public void readGroup(int fieldNumber,
 MessageLite.Builder builder,
 ExtensionRegistryLite extensionRegistry)
               throws IOException

Description copied from class: CodedInputStream

Read a group field value from the stream.

Specified by:

readGroup in class CodedInputStream

Throws:

IOException

readGroup

public <T extends MessageLite> T readGroup(int fieldNumber,
 Parser<T> parser,
 ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Description copied from class: CodedInputStream

Read a group field value from the stream.

Specified by:

readGroup in class CodedInputStream

Throws:

IOException

readUnknownGroup

@Deprecated
public void readUnknownGroup(int fieldNumber,
 MessageLite.Builder builder)
                      throws IOException

Deprecated.

Description copied from class: CodedInputStream

Reads a group field value from the stream and merges it into the given UnknownFieldSet.

Specified by:

readUnknownGroup in class CodedInputStream

Throws:

IOException

readMessage

public void readMessage(MessageLite.Builder builder,
 ExtensionRegistryLite extensionRegistry)
                 throws IOException

Description copied from class: CodedInputStream

Read an embedded message field value from the stream.

Specified by:

readMessage in class CodedInputStream

Throws:

IOException

readMessage

public <T extends MessageLite> T readMessage(Parser<T> parser,
 ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Description copied from class: CodedInputStream

Read an embedded message field value from the stream.

Specified by:

readMessage in class CodedInputStream

Throws:

IOException

pushLimitBeforeMessage

private int pushLimitBeforeMessage()
                            throws IOException

Throws:

IOException

popLimitAfterMessage

private void popLimitAfterMessage(int oldLimit)
                           throws IOException

Throws:

IOException

readBytesInternal

private ByteString readBytesInternal(boolean requireUtf8)
                              throws IOException

Throws:

IOException

readBytes

public ByteString readBytes()
                     throws IOException

Description copied from class: CodedInputStream

Read a bytes field value from the stream.

When CodedInputStream.enableAliasing(boolean) is enabled and supported by the underlying decoder, the returned ByteString may reference (alias) the underlying input buffer instead of copying the bytes.

Safety contract: Callers must ensure the underlying input buffer is not mutated or reused while the returned ByteString is still in use. If you cannot guarantee buffer lifetime, do not enable aliasing or copy the bytes before storing them.

Specified by:

readBytes in class CodedInputStream

Throws:

IOException

readByteArray

public byte[] readByteArray()
                     throws IOException

Description copied from class: CodedInputStream

Read a bytes field value from the stream.

Specified by:

readByteArray in class CodedInputStream

Throws:

IOException

readByteBuffer

public ByteBuffer readByteBuffer()
                          throws IOException

Description copied from class: CodedInputStream

Read a bytes field value from the stream.

If aliasing is enabled, the returned ByteBuffer may reference (alias) the underlying input buffer for decoders that are backed by an on-heap byte[] whose contents will not be overwritten or reused for the lifetime of the returned view.

Safety contract: Callers should treat the returned buffer as read-only and should not rely on its contents remaining valid after the input advances. If you need a stable, read-only view, consider calling ByteBuffer.asReadOnlyBuffer() immediately on the returned buffer.

Specified by:

readByteBuffer in class CodedInputStream

Throws:

IOException

readUInt32

public int readUInt32()
               throws IOException

Description copied from class: CodedInputStream

Read a uint32 field value from the stream.

Specified by:

readUInt32 in class CodedInputStream

Throws:

IOException

readEnum

public int readEnum()
             throws IOException

Description copied from class: CodedInputStream

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

Specified by:

readEnum in class CodedInputStream

Throws:

IOException

readSFixed32

public int readSFixed32()
                 throws IOException

Description copied from class: CodedInputStream

Read an sfixed32 field value from the stream.

Specified by:

readSFixed32 in class CodedInputStream

Throws:

IOException

readSFixed64

public long readSFixed64()
                  throws IOException

Description copied from class: CodedInputStream

Read an sfixed64 field value from the stream.

Specified by:

readSFixed64 in class CodedInputStream

Throws:

IOException

readSInt32

public int readSInt32()
               throws IOException

Description copied from class: CodedInputStream

Read an sint32 field value from the stream.

Specified by:

readSInt32 in class CodedInputStream

Throws:

IOException

readSInt64

public long readSInt64()
                throws IOException

Description copied from class: CodedInputStream

Read an sint64 field value from the stream.

Specified by:

readSInt64 in class CodedInputStream

Throws:

IOException

readRawVarint32Expected5BytesMax

protected abstract int readRawVarint32Expected5BytesMax()
                                                 throws IOException

Temporary shim to enable new varint experiment.

Same as readRawVarint32 but for callers where the varint being longer than 5 bytes should never happen in practice (eg tags and lengths).

Throws:

IOException

readRawVarint32Expected10BytesMax

protected abstract int readRawVarint32Expected10BytesMax()
                                                  throws IOException

Temporary shim to enable new varint experiment.

Same as readRawVarint32 but for callers where a 10-byte varint is 'normal' (eg int32 fields where negative values will be 10 bytes).

Throws:

IOException

readRawVarint32

public int readRawVarint32()
                    throws IOException

Description copied from class: CodedInputStream

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

Specified by:

readRawVarint32 in class CodedInputStream

Throws:

IOException

readRawVarint32Old

protected int readRawVarint32Old()
                          throws IOException

Throws:

IOException

readRawVarint32New

protected int readRawVarint32New()
                          throws IOException

Throws:

IOException

readRawVarint32NewFast

private int readRawVarint32NewFast()
                            throws IOException

Fast case: the limit is not checked here, this may read in the buffer past the limit, and may throw an IndexOutOfBoundsException if the varint runs off the end of the buffer.

Throws:

IOException

skipRawVarint

private void skipRawVarint()
                    throws IOException

Throws:

IOException

skipRawVarintFastPath

private void skipRawVarintFastPath()
                            throws IOException

Throws:

IOException

skipRawVarintSlowPath

private void skipRawVarintSlowPath()
                            throws IOException

Throws:

IOException

readRawVarint64

public long readRawVarint64()
                     throws IOException

Description copied from class: CodedInputStream

Read a raw Varint from the stream.

Specified by:

readRawVarint64 in class CodedInputStream

Throws:

IOException

readRawVarint64SlowPath

long readRawVarint64SlowPath()
                      throws IOException

Description copied from class: CodedInputStream

Variant of readRawVarint64 for when uncomfortably close to the limit.

Specified by:

readRawVarint64SlowPath in class CodedInputStream

Throws:

IOException

readRawLittleEndian32

public int readRawLittleEndian32()
                          throws IOException

Description copied from class: CodedInputStream

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

Specified by:

readRawLittleEndian32 in class CodedInputStream

Throws:

IOException

readRawLittleEndian64

public long readRawLittleEndian64()
                           throws IOException

Description copied from class: CodedInputStream

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

Specified by:

readRawLittleEndian64 in class CodedInputStream

Throws:

IOException

enableAliasing

public void enableAliasing(boolean enabled)

Description copied from class: CodedInputStream

Enables aliasing of the underlying input buffer for buffer-backed decoders.

When aliasing is enabled and supported by the underlying decoder, CodedInputStream.readBytes() and CodedInputStream.readByteBuffer() may return views into the underlying input buffer instead of copying the bytes. This can reduce allocations and improve throughput for workloads that parse many length-delimited bytes fields.

Some decoder implementations may ignore this setting (i.e., treat it as a no-op), such as stream-backed decoders whose internal buffers are refilled and reused (and therefore may overwrite previously returned views), or direct-backed decoders that are not backed by a stable on-heap byte[].

Safety contract: If aliasing is enabled, the caller must ensure the underlying input buffer is not mutated or reused while any returned ByteString or ByteBuffer is still in use. If you cannot guarantee buffer lifetime (for example, when using pooled buffers), do not enable aliasing or copy the bytes before storing them.

Aliasing is generally only possible for array-backed decoders. Stream-backed decoders typically do not support aliasing because their internal buffers are refilled and reused.

Note: CodedInputStream.readByteBuffer() may return a mutable ByteBuffer even when it aliases the underlying input. Callers that require safety-by-default should treat the returned buffer as read-only or call ByteBuffer.asReadOnlyBuffer() immediately.

Specified by:

enableAliasing in class CodedInputStream

resetSizeCounter

public void resetSizeCounter()

Description copied from class: CodedInputStream

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

Specified by:

resetSizeCounter in class CodedInputStream

pushLimit

@CanIgnoreReturnValue
public int pushLimit(int byteLimit)
              throws InvalidProtocolBufferException

Description copied from class: CodedInputStream

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.

Specified by:

pushLimit in class CodedInputStream

Returns:

the old limit.

Throws:

InvalidProtocolBufferException

setCurrentLimit

private void setCurrentLimit(int newLimit)

Sets the active message boundary (currentLimit) and clamps the reading limit ( limit).

popLimit

public void popLimit(int oldLimit)

Description copied from class: CodedInputStream

Discards the current limit, returning to the previous limit.

Specified by:

popLimit in class CodedInputStream

Parameters:

oldLimit - The old limit, as returned by pushLimit.

getBytesUntilLimit

public int getBytesUntilLimit()

Description copied from class: CodedInputStream

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

Specified by:

getBytesUntilLimit in class CodedInputStream

isAtEnd

public boolean isAtEnd()
                throws IOException

Description copied from class: CodedInputStream

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 CodedInputStream.pushLimit(int). This function may get blocked when using StreamDecoder as it invokes CodedInputStream.StreamDecoder.tryRefillBuffer(int) in this function which will try to read bytes from input.

Specified by:

isAtEnd in class CodedInputStream

Throws:

IOException

getTotalBytesRead

public int getTotalBytesRead()

Description copied from class: CodedInputStream

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

Specified by:

getTotalBytesRead in class CodedInputStream

readRawByte

public byte readRawByte()
                 throws IOException

Description copied from class: CodedInputStream

Read one byte from the input.

Specified by:

readRawByte in class CodedInputStream

Throws:

IOException

readRawBytes

public byte[] readRawBytes(int length)
                    throws IOException

Description copied from class: CodedInputStream

Read a fixed size of bytes from the input.

Specified by:

readRawBytes in class CodedInputStream

Throws:

IOException

streamRawBytes

public int streamRawBytes(byte[] bytes,
 int offset,
 int length)
                   throws IOException

Description copied from class: CodedInputStream

Read up to length bytes into bytes starting at offset.

Behaves similarly to InputStream.read(byte[],int,int); a zero-sized read will read zero bytes, other sizes will attempt to read up to the requested number of bytes, but may read less.

Specified by:

streamRawBytes in class CodedInputStream

Returns:

The number of bytes read into bytes, or -1 if the end of data or current limit has been reached.

Throws:

IOException

skipRawBytes

public void skipRawBytes(int length)
                  throws IOException

Description copied from class: CodedInputStream

Reads and discards size bytes.

Specified by:

skipRawBytes in class CodedInputStream

Throws:

IOException