ProtoSource (quickbuf-runtime 1.4 API)

java.lang.Object
- us.hebi.quickbuf.ProtoSource

```
public abstract class ProtoSource
extends Object
```
NOTE: the code was modified from Javanano's CodedInputByteBufferNano Reads and decodes protocol message fields.
This class contains two kinds of methods: methods that read specific protocol message constructs and field types (e.g. readTag() and readInt32()) and methods that read low-level values (e.g. readRawVarint32() and readRawVarint64()). If you are reading encoded protocol messages, you should use the former methods, but if you are reading some other format of your own design, use the latter.

Author:

kenton@google.com Kenton Varda, Florian Enner

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`currentLimit` The absolute position of the end of the current message.
`protected static int`	`NO_LIMIT`
`protected int`	`recursionDepth` See setRecursionLimit()
`protected int`	`recursionLimit`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ProtoSource()

Constructors
Modifier	Constructor and Description
`protected`	`ProtoSource()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkLastTagWas(int value)` Verifies that the last call to readTag() returned the given tag value.
`abstract ProtoSource`	`clear()` Clears internal state and removes any references to previous inputs.
`static int`	`decodeZigZag32(int n)` Decode a ZigZag-encoded 32-bit value.
`static long`	`decodeZigZag64(long n)` Decode a ZigZag-encoded 64-bit value.
`ProtoSource`	`discardUnknownFields()` Sets this `ProtoSource` to discard unknown fields.
`int`	`getBytesUntilLimit()` Returns the number of bytes to be read before the current limit.
`abstract int`	`getTotalBytesRead()` The total bytes read up to the current position.
`abstract boolean`	`isAtEnd()` Returns true if the source has reached the end of the input.
`static ProtoSource`	`newArraySource()` Creates a new `ProtoSource` that reads directly from a byte array.
`static ProtoSource`	`newBufferSource()` Creates a new `ProtoSource` that reads from an `ByteBuffer`.
`static ProtoSource`	`newDirectSource()` Creates a new `ProtoSource` that reads from a byte array or direct / off-heap memory.
`static ProtoSource`	`newInstance(byte[] buf)` Create a new ProtoSource reading from the given byte array.
`static ProtoSource`	`newInstance(byte[] buf, int off, int len)` Create a new ProtoSource reading from the given byte array slice.
`static ProtoSource`	`newInstance(ByteBuffer buffer)` Create a new ProtoSource reading from the given `ByteBuffer`.
`static ProtoSource`	`newInstance(InputStream stream)` Create a new ProtoSource reading from the given `InputStream`.
`static ProtoSource`	`newInstance(RepeatedByte bytes)` Create a new ProtoSource reading from the current array of the given `RepeatedByte`.
`static ProtoSource`	`newStreamSource()` Creates a new `ProtoSource` that reads from an `InputStream`.
`void`	`popLimit(int oldLimit)` Discards the current limit, returning to the previous limit.
`int`	`pushLimit(int byteLimit)` Sets `currentLimit` to (current position) + `byteLimit`.
`boolean`	`readBool()` Read a `bool` field value from the source.
`void`	`readBytes(RepeatedByte store)` Read a `bytes` field value from the source.
`double`	`readDouble()` Read a `double` field value from the source.
`int`	`readEnum()` Read an enum field value from the source.
`int`	`readFixed32()` Read a `fixed32` field value from the source.
`long`	`readFixed64()` Read a `fixed64` field value from the source.
`float`	`readFloat()` Read a `float` field value from the source.
`void`	`readGroup(ProtoMessage<?> msg, int fieldNumber)` Read a `group` field value from the source.
`int`	`readInt32()` Read an `int32` field value from the source.
`long`	`readInt64()` Read an `int64` field value from the source.
`int`	`readLength()` Read a length delimiter from the source.
`void`	`readMessage(ProtoMessage<?> msg)`
`void`	`readPackedBool(RepeatedBoolean store)` Read a repeated (packed) `bool` field value from the source.
`void`	`readPackedDouble(RepeatedDouble store)` Read a repeated (packed) `double` field value from the source.
`void`	`readPackedEnum(RepeatedEnum<?> store, int tag)` Read a repeated (packed) `enum` field value from the source.
`void`	`readPackedFixed32(RepeatedInt store)` Read a repeated (packed) `fixed32` field value from the source.
`void`	`readPackedFixed64(RepeatedLong store)` Read a repeated (packed) `fixed64` field value from the source.
`void`	`readPackedFloat(RepeatedFloat store)` Read a repeated (packed) `float` field value from the source.
`void`	`readPackedInt32(RepeatedInt store, int tag)` Read a repeated (packed) `int32` field value from the source.
`void`	`readPackedInt64(RepeatedLong store, int tag)` Read a repeated (packed) `int64` field value from the source.
`void`	`readPackedSFixed32(RepeatedInt store)` Read a repeated (packed) `sfixed32` field value from the source.
`void`	`readPackedSFixed64(RepeatedLong store)` Read a repeated (packed) `sfixed64` field value from the source.
`void`	`readPackedSInt32(RepeatedInt store, int tag)` Read a repeated (packed) `sint32` field value from the source.
`void`	`readPackedSInt64(RepeatedLong store, int tag)` Read a repeated (packed) `sint64` field value from the source.
`void`	`readPackedUInt32(RepeatedInt store, int tag)` Read a repeated (packed) `uint32` field value from the source.
`void`	`readPackedUInt64(RepeatedLong store, int tag)` Read a repeated (packed) `uint64` field value from the source.
`abstract byte`	`readRawByte()` Read one byte from the input.
`void`	`readRawBytes(byte[] values, int offset, int length)` Read raw `bytes` from the source.
`protected void`	`readRawDoubles(double[] values, int offset, int length)`
`protected void`	`readRawFixed32s(int[] values, int offset, int length)`
`protected void`	`readRawFixed64s(long[] values, int offset, int length)`
`protected void`	`readRawFloats(float[] values, int offset, int length)`
`short`	`readRawLittleEndian16()` Read a 16-bit little-endian integer from the source.
`int`	`readRawLittleEndian32()` Read a 32-bit little-endian integer from the source.
`long`	`readRawLittleEndian64()` Read a 64-bit little-endian integer from the source.
`int`	`readRawVarint32()`
`static int`	`readRawVarint32(InputStream input)` Reads a varint from the input one byte at a time, so that it does not read any bytes after the end of the varint.
`static int`	`readRawVarint32(int firstByte, InputStream input)` Like `readRawVarint32(InputStream)`, but expects that the caller has already read one byte.
`long`	`readRawVarint64()` Read a raw Varint from the source.
`int`	`readRepeatedBool(RepeatedBoolean store, int tag)` Read a repeated (non-packed) `bool` field value from the source.
`int`	`readRepeatedBytes(RepeatedBytes store, int tag)` Read a repeated `bytes` field value from the source.
`int`	`readRepeatedDouble(RepeatedDouble store, int tag)` Read a repeated (non-packed) `double` field value from the source.
`int`	`readRepeatedEnum(RepeatedEnum<?> store, int tag)` Read a repeated `enum` field value from the source.
`int`	`readRepeatedFixed32(RepeatedInt store, int tag)` Read a repeated (non-packed) `fixed32` field value from the source.
`int`	`readRepeatedFixed64(RepeatedLong store, int tag)` Read a repeated (non-packed) `fixed64` field value from the source.
`int`	`readRepeatedFloat(RepeatedFloat store, int tag)` Read a repeated (non-packed) `float` field value from the source.
`int`	`readRepeatedGroup(RepeatedMessage<?> store, int tag)` Read a repeated `group` field value from the source.
`int`	`readRepeatedInt32(RepeatedInt store, int tag)` Read a repeated `int32` field value from the source.
`int`	`readRepeatedInt64(RepeatedLong store, int tag)` Read a repeated `int64` field value from the source.
`int`	`readRepeatedMessage(RepeatedMessage<?> store, int tag)` Read a repeated `message` field value from the source.
`int`	`readRepeatedSFixed32(RepeatedInt store, int tag)` Read a repeated (non-packed) `sfixed32` field value from the source.
`int`	`readRepeatedSFixed64(RepeatedLong store, int tag)` Read a repeated (non-packed) `sfixed64` field value from the source.
`int`	`readRepeatedSInt32(RepeatedInt store, int tag)` Read a repeated `sint32` field value from the source.
`int`	`readRepeatedSInt64(RepeatedLong store, int tag)` Read a repeated `sint64` field value from the source.
`int`	`readRepeatedString(RepeatedString store, int tag)` Read a repeated `string` field value from the source.
`int`	`readRepeatedUInt32(RepeatedInt store, int tag)` Read a repeated `uint32` field value from the source.
`int`	`readRepeatedUInt64(RepeatedLong store, int tag)` Read a repeated `uint64` field value from the source.
`int`	`readSFixed32()` Read an `sfixed32` field value from the source.
`long`	`readSFixed64()` Read an `sfixed64` field value from the source.
`int`	`readSInt32()` Read an `sint32` field value from the source.
`long`	`readSInt64()` Read an `sint64` field value from the source.
`void`	`readString(Utf8String store)` Read a `string` field value from the source.
`int`	`readTag()` Attempt to read a field tag, returning zero if we have reached EOF.
`int`	`readUInt32()` Read a `uint32` field value from the source.
`long`	`readUInt64()` Read a `uint64` field value from the source.
`protected void`	`reservePackedVarintCapacity(us.hebi.quickbuf.RepeatedField<?,?> store)` Reserves space in the repeated field store to hold the number of remaining varints until the limit or end of stream is reached.
`protected void`	`reserveRepeatedFieldCapacity(us.hebi.quickbuf.RepeatedField<?,?> store, int tag)` Reserves space in the repeated field store to hold additional values.
`protected ProtoSource`	`resetInternalState()`
`ProtoSource`	`resetSizeCounter()` Resets the current size counter to zero (see `setSizeLimit(int)`).
`abstract void`	`rewindTo(int totalBytesRead)` Rewinds the internal position to match the desired number of bytes read.
`ProtoSource`	`setInput(byte[] buffer)` Changes the input to the given array.
`ProtoSource`	`setInput(byte[] buffer, long off, int len)` Changes the input to the given array.
`ProtoSource`	`setInput(ByteBuffer buffer)` Changes the input to the given buffer.
`ProtoSource`	`setInput(InputStream stream)` Changes the input to the given stream.
`ProtoSource`	`setInput(RepeatedByte bytes)` Changes the input to the current array of the given `RepeatedByte`.
`int`	`setRecursionLimit(int limit)` Set the maximum message recursion depth.
`int`	`setSizeLimit(int limit)` Only valid for `InputStream`-backed streams.
`void`	`skipEnum(int tag, int value, RepeatedByte unknownBytes)` Skips an enum that has already been read, but had a value that is not known.
`boolean`	`skipField(int tag)` Reads and discards a single field, given its tag value.
`boolean`	`skipField(int tag, RepeatedByte unknownBytes)` Reads and discards a single field, given its tag value.
`protected void`	`skipMessage()` Reads and discards an entire message.
`protected void`	`skipMessage(RepeatedByte unknownBytes)`
`abstract void`	`skipRawBytes(int size)` Reads and discards `size` bytes.
`ProtoSource`	`unsetDiscardUnknownFields()` Reverts the unknown fields preservation behavior to the default.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - recursionDepth
```
protected int recursionDepth
```
    See setRecursionLimit()
  - recursionLimit
```
protected int recursionLimit
```
  - currentLimit
```
protected int currentLimit
```
    The absolute position of the end of the current message.
  - NO_LIMIT
```
protected static final int NO_LIMIT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProtoSource
```
protected ProtoSource()
```
- Method Detail
  - newInstance
```
public static ProtoSource newInstance(byte[] buf)
```
    Create a new ProtoSource reading from the given byte array.
  - newInstance
```
public static ProtoSource newInstance(byte[] buf,
                                      int off,
                                      int len)
```
    Create a new ProtoSource reading from the given byte array slice.
  - newInstance
```
public static ProtoSource newInstance(RepeatedByte bytes)
```
    Create a new ProtoSource reading from the current array of the given RepeatedByte.
  - newInstance
```
public static ProtoSource newInstance(InputStream stream)
```
    Create a new ProtoSource reading from the given InputStream.
  - newInstance
```
public static ProtoSource newInstance(ByteBuffer buffer)
```
    Create a new ProtoSource reading from the given ByteBuffer.
  - newArraySource
```
public static ProtoSource newArraySource()
```
    Creates a new ProtoSource that reads directly from a byte array. This method will return the fastest implementation available for the current platform and may leverage features from sun.misc.Unsafe if available.
  - newDirectSource
```
public static ProtoSource newDirectSource()
```
    Creates a new ProtoSource that reads from a byte array or direct / off-heap memory. It is similar to the array source, but it allows null buffers to support raw memory addresses. This source requires availability of sun.misc.Unsafe. Be aware that passing incorrect memory addresses may cause the entire runtime to segfault.
  - newStreamSource
```
public static ProtoSource newStreamSource()
```
    Creates a new ProtoSource that reads from an InputStream. The current implementation is a very lightweight wrapper that reads byte-by-byte and does not do any internal buffering. This is slower than reading from an array, but it does not require extra memory.
  - newBufferSource
```
public static ProtoSource newBufferSource()
```
    Creates a new ProtoSource that reads from an ByteBuffer. The current implementation is a very lightweight wrapper that reads individual bytes. This is slower than reading from an array, but it works on all platforms.
  - setInput
```
public final ProtoSource setInput(byte[] buffer)
```
    Changes the input to the given array. This resets any existing internal state such as position and is equivalent to creating a new instance.
  - setInput
```
public ProtoSource setInput(byte[] buffer,
                            long off,
                            int len)
```
    Changes the input to the given array. This resets any existing internal state such as position and is equivalent to creating a new instance.
  - setInput
```
public final ProtoSource setInput(RepeatedByte bytes)
```
    Changes the input to the current array of the given RepeatedByte.
  - setInput
```
public ProtoSource setInput(InputStream stream)
```
    Changes the input to the given stream. This resets any existing internal state such as position and is equivalent to creating a new instance.
  - setInput
```
public ProtoSource setInput(ByteBuffer buffer)
```
    Changes the input to the given buffer. This resets any existing internal state such as position and is equivalent to creating a new instance. A BufferSource wraps the buffer directly and modifies the buffer state. ArraySource and DirectSource wrap the backing memory and do not modify the buffer state.
  - clear
```
public abstract ProtoSource clear()
```
    Clears internal state and removes any references to previous inputs.
  - readTag
```
public int readTag()
            throws IOException
```
    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.
    
    Throws:
    
    IOException
  - checkLastTagWas
```
public void checkLastTagWas(int value)
                     throws InvalidProtocolBufferException
```
    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.
    
    Throws:
    
    InvalidProtocolBufferException - value does not match the last tag.
  - skipField
```
public boolean skipField(int tag)
                  throws IOException
```
    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.
    
    Throws:
    
    IOException
  - skipField
```
public boolean skipField(int tag,
                         RepeatedByte unknownBytes)
                  throws IOException
```
    Reads and discards a single field, given its tag value. Discarded bytes are added to unknownBytes.
    
    Returns:
    
    false if the tag is an endgroup tag, in which case nothing is skipped. Otherwise, returns true.
    
    Throws:
    
    IOException
  - skipEnum
```
public void skipEnum(int tag,
                     int value,
                     RepeatedByte unknownBytes)
              throws IOException
```
    Skips an enum that has already been read, but had a value that is not known. Discarded bytes are added to unknownBytes.
    
    Throws:
    
    IOException
  - skipMessage
```
protected void skipMessage()
                    throws IOException
```
    Reads and discards an entire message. This will read either until EOF or until an endgroup tag, whichever comes first.
    
    Throws:
    
    IOException
  - skipMessage
```
protected void skipMessage(RepeatedByte unknownBytes)
                    throws IOException
```
    Throws:
    
    IOException
  - readPackedDouble
```
public void readPackedDouble(RepeatedDouble store)
                      throws IOException
```
    Read a repeated (packed) double field value from the source.
    
    Throws:
    
    IOException
  - readRawDoubles
```
protected void readRawDoubles(double[] values,
                              int offset,
                              int length)
                       throws IOException
```
    Throws:
    
    IOException
  - readRepeatedDouble
```
public int readRepeatedDouble(RepeatedDouble store,
                              int tag)
                       throws IOException
```
    Read a repeated (non-packed) double field value from the source.
    
    Throws:
    
    IOException
  - readDouble
```
public double readDouble()
                  throws IOException
```
    Read a double field value from the source.
    
    Throws:
    
    IOException
  - readPackedFloat
```
public void readPackedFloat(RepeatedFloat store)
                     throws IOException
```
    Read a repeated (packed) float field value from the source.
    
    Throws:
    
    IOException
  - readRawFloats
```
protected void readRawFloats(float[] values,
                             int offset,
                             int length)
                      throws IOException
```
    Throws:
    
    IOException
  - readRepeatedFloat
```
public int readRepeatedFloat(RepeatedFloat store,
                             int tag)
                      throws IOException
```
    Read a repeated (non-packed) float field value from the source.
    
    Throws:
    
    IOException
  - readFloat
```
public float readFloat()
                throws IOException
```
    Read a float field value from the source.
    
    Throws:
    
    IOException
  - readPackedSFixed64
```
public void readPackedSFixed64(RepeatedLong store)
                        throws IOException
```
    Read a repeated (packed) sfixed64 field value from the source.
    
    Throws:
    
    IOException
  - readPackedFixed64
```
public void readPackedFixed64(RepeatedLong store)
                       throws IOException
```
    Read a repeated (packed) fixed64 field value from the source.
    
    Throws:
    
    IOException
  - readRawFixed64s
```
protected void readRawFixed64s(long[] values,
                               int offset,
                               int length)
                        throws IOException
```
    Throws:
    
    IOException
  - readRepeatedSFixed64
```
public int readRepeatedSFixed64(RepeatedLong store,
                                int tag)
                         throws IOException
```
    Read a repeated (non-packed) sfixed64 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedFixed64
```
public int readRepeatedFixed64(RepeatedLong store,
                               int tag)
                        throws IOException
```
    Read a repeated (non-packed) fixed64 field value from the source.
    
    Throws:
    
    IOException
  - readSFixed64
```
public long readSFixed64()
                  throws IOException
```
    Read an sfixed64 field value from the source.
    
    Throws:
    
    IOException
  - readFixed64
```
public long readFixed64()
                 throws IOException
```
    Read a fixed64 field value from the source.
    
    Throws:
    
    IOException
  - readPackedSFixed32
```
public void readPackedSFixed32(RepeatedInt store)
                        throws IOException
```
    Read a repeated (packed) sfixed32 field value from the source.
    
    Throws:
    
    IOException
  - readPackedFixed32
```
public void readPackedFixed32(RepeatedInt store)
                       throws IOException
```
    Read a repeated (packed) fixed32 field value from the source.
    
    Throws:
    
    IOException
  - readRawFixed32s
```
protected void readRawFixed32s(int[] values,
                               int offset,
                               int length)
                        throws IOException
```
    Throws:
    
    IOException
  - readRepeatedSFixed32
```
public int readRepeatedSFixed32(RepeatedInt store,
                                int tag)
                         throws IOException
```
    Read a repeated (non-packed) sfixed32 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedFixed32
```
public int readRepeatedFixed32(RepeatedInt store,
                               int tag)
                        throws IOException
```
    Read a repeated (non-packed) fixed32 field value from the source.
    
    Throws:
    
    IOException
  - readSFixed32
```
public int readSFixed32()
                 throws IOException
```
    Read an sfixed32 field value from the source.
    
    Throws:
    
    IOException
  - readFixed32
```
public int readFixed32()
                throws IOException
```
    Read a fixed32 field value from the source.
    
    Throws:
    
    IOException
  - readPackedUInt64
```
public void readPackedUInt64(RepeatedLong store,
                             int tag)
                      throws IOException
```
    Read a repeated (packed) uint64 field value from the source.
    
    Throws:
    
    IOException
  - readPackedInt64
```
public void readPackedInt64(RepeatedLong store,
                            int tag)
                     throws IOException
```
    Read a repeated (packed) int64 field value from the source.
    
    Throws:
    
    IOException
  - readPackedSInt64
```
public void readPackedSInt64(RepeatedLong store,
                             int tag)
                      throws IOException
```
    Read a repeated (packed) sint64 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedUInt64
```
public int readRepeatedUInt64(RepeatedLong store,
                              int tag)
                       throws IOException
```
    Read a repeated uint64 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedInt64
```
public int readRepeatedInt64(RepeatedLong store,
                             int tag)
                      throws IOException
```
    Read a repeated int64 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedSInt64
```
public int readRepeatedSInt64(RepeatedLong store,
                              int tag)
                       throws IOException
```
    Read a repeated sint64 field value from the source.
    
    Throws:
    
    IOException
  - readUInt64
```
public long readUInt64()
                throws IOException
```
    Read a uint64 field value from the source.
    
    Throws:
    
    IOException
  - readInt64
```
public long readInt64()
               throws IOException
```
    Read an int64 field value from the source.
    
    Throws:
    
    IOException
  - readSInt64
```
public long readSInt64()
                throws IOException
```
    Read an sint64 field value from the source.
    
    Throws:
    
    IOException
  - readPackedUInt32
```
public void readPackedUInt32(RepeatedInt store,
                             int tag)
                      throws IOException
```
    Read a repeated (packed) uint32 field value from the source.
    
    Throws:
    
    IOException
  - readPackedInt32
```
public void readPackedInt32(RepeatedInt store,
                            int tag)
                     throws IOException
```
    Read a repeated (packed) int32 field value from the source.
    
    Throws:
    
    IOException
  - readPackedSInt32
```
public void readPackedSInt32(RepeatedInt store,
                             int tag)
                      throws IOException
```
    Read a repeated (packed) sint32 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedUInt32
```
public int readRepeatedUInt32(RepeatedInt store,
                              int tag)
                       throws IOException
```
    Read a repeated uint32 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedInt32
```
public int readRepeatedInt32(RepeatedInt store,
                             int tag)
                      throws IOException
```
    Read a repeated int32 field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedSInt32
```
public int readRepeatedSInt32(RepeatedInt store,
                              int tag)
                       throws IOException
```
    Read a repeated sint32 field value from the source.
    
    Throws:
    
    IOException
  - readUInt32
```
public int readUInt32()
               throws IOException
```
    Read a uint32 field value from the source.
    
    Throws:
    
    IOException
  - readInt32
```
public int readInt32()
              throws IOException
```
    Read an int32 field value from the source.
    
    Throws:
    
    IOException
  - readSInt32
```
public int readSInt32()
               throws IOException
```
    Read an sint32 field value from the source.
    
    Throws:
    
    IOException
  - readPackedBool
```
public void readPackedBool(RepeatedBoolean store)
                    throws IOException
```
    Read a repeated (packed) bool field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedBool
```
public int readRepeatedBool(RepeatedBoolean store,
                            int tag)
                     throws IOException
```
    Read a repeated (non-packed) bool field value from the source.
    
    Throws:
    
    IOException
  - readBool
```
public boolean readBool()
                 throws IOException
```
    Read a bool field value from the source.
    
    Throws:
    
    IOException
  - readPackedEnum
```
public void readPackedEnum(RepeatedEnum<?> store,
                           int tag)
                    throws IOException
```
    Read a repeated (packed) enum field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedEnum
```
public int readRepeatedEnum(RepeatedEnum<?> store,
                            int tag)
                     throws IOException
```
    Read a repeated enum field value from the source.
    
    Throws:
    
    IOException
  - readEnum
```
public int readEnum()
             throws IOException
```
    Read an enum field value from the source. Caller is responsible for converting the numeric value to an actual enum.
    
    Throws:
    
    IOException
  - readLength
```
public int readLength()
               throws IOException
```
    Read a length delimiter from the source.
    
    Throws:
    
    IOException
  - readRepeatedString
```
public int readRepeatedString(RepeatedString store,
                              int tag)
                       throws IOException
```
    Read a repeated string field value from the source.
    
    Throws:
    
    IOException
  - readString
```
public void readString(Utf8String store)
                throws IOException
```
    Read a string field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedGroup
```
public int readRepeatedGroup(RepeatedMessage<?> store,
                             int tag)
                      throws IOException
```
    Read a repeated group field value from the source.
    
    Throws:
    
    IOException
  - readGroup
```
public void readGroup(ProtoMessage<?> msg,
                      int fieldNumber)
               throws IOException
```
    Read a group field value from the source.
    
    Throws:
    
    IOException
  - readRepeatedMessage
```
public int readRepeatedMessage(RepeatedMessage<?> store,
                               int tag)
                        throws IOException
```
    Read a repeated message field value from the source.
    
    Throws:
    
    IOException
  - readMessage
```
public void readMessage(ProtoMessage<?> msg)
                 throws IOException
```
    Throws:
    
    IOException
  - readRepeatedBytes
```
public int readRepeatedBytes(RepeatedBytes store,
                             int tag)
                      throws IOException
```
    Read a repeated bytes field value from the source.
    
    Throws:
    
    IOException
  - readBytes
```
public void readBytes(RepeatedByte store)
               throws IOException
```
    Read a bytes field value from the source.
    
    Throws:
    
    IOException
  - readRawBytes
```
public void readRawBytes(byte[] values,
                         int offset,
                         int length)
                  throws IOException
```
    Read raw bytes from the source.
    
    Throws:
    
    IOException
  - readRawVarint32
```
public int readRawVarint32()
                    throws IOException
```
    Throws:
    
    IOException
  - readRawVarint64
```
public long readRawVarint64()
                     throws IOException
```
    Read a raw Varint from the source.
    
    Throws:
    
    IOException
  - readRawLittleEndian16
```
public short readRawLittleEndian16()
                            throws IOException
```
    Read a 16-bit little-endian integer from the source.
    
    Throws:
    
    IOException
  - readRawLittleEndian32
```
public int readRawLittleEndian32()
                          throws IOException
```
    Read a 32-bit little-endian integer from the source.
    
    Throws:
    
    IOException
  - readRawLittleEndian64
```
public long readRawLittleEndian64()
                           throws IOException
```
    Read a 64-bit little-endian integer from the source.
    
    Throws:
    
    IOException
  - decodeZigZag32
```
public static int decodeZigZag32(int n)
```
    Decode a ZigZag-encoded 32-bit value. ZigZag encodes signed integers into values that can be efficiently encoded with varint. (Otherwise, negative values must be sign-extended to 64 bits to be varint encoded, thus always taking 10 bytes on the wire.)
    
    Parameters:
    
    n - An unsigned 32-bit integer, stored in a signed int because Java has no explicit unsigned support.
    
    Returns:
    
    A signed 32-bit integer.
  - decodeZigZag64
```
public static long decodeZigZag64(long n)
```
    Decode a ZigZag-encoded 64-bit value. ZigZag encodes signed integers into values that can be efficiently encoded with varint. (Otherwise, negative values must be sign-extended to 64 bits to be varint encoded, thus always taking 10 bytes on the wire.)
    
    Parameters:
    
    n - An unsigned 64-bit integer, stored in a signed int because Java has no explicit unsigned support.
    
    Returns:
    
    A signed 64-bit integer.
  - resetInternalState
```
protected ProtoSource resetInternalState()
```
  - setRecursionLimit
```
public int setRecursionLimit(int limit)
```
    Set the maximum message recursion depth. In order to prevent malicious messages from causing stack overflows, ProtoSource limits how deeply messages may be nested. The default limit is 64.
    
    Returns:
    
    the old limit.
  - setSizeLimit
```
public int setSizeLimit(int limit)
```
    Only valid for InputStream-backed streams.
    Set the maximum message size. In order to prevent malicious messages from exhausting memory or causing integer overflows, ProtoSource limits how large a message may be. The default limit is Integer.MAX_VALUE. You should set this limit as small as you can without harming your app's functionality. Note that size limits only apply when reading from an InputStream, not when constructed around a raw byte array.
    If you want to read several messages from a single CodedInputStream, you could call resetSizeCounter() after each one to avoid hitting the size limit.
    
    Returns:
    
    the old limit.
  - resetSizeCounter
```
public ProtoSource resetSizeCounter()
```
    Resets the current size counter to zero (see setSizeLimit(int)). Only valid for InputStream-backed streams.
    
    Returns:
    
    this
  - discardUnknownFields
```
public final ProtoSource discardUnknownFields()
```
    Sets this ProtoSource to discard unknown fields. This only impacts messages that were generated with support for retaining unknown fields.
    Note calling this function alone will have NO immediate effect on the underlying input data. The unknown fields will be discarded during parsing.
  - unsetDiscardUnknownFields
```
public final ProtoSource unsetDiscardUnknownFields()
```
    Reverts the unknown fields preservation behavior to the default. This only applies to messages that were generated with support for retaining unknown fields.
  - pushLimit
```
public int pushLimit(int byteLimit)
              throws InvalidProtocolBufferException
```
    Sets currentLimit to (current position) + byteLimit. This is called when descending into a length-delimited embedded message.
    
    Returns:
    
    the old limit.
    
    Throws:
    
    InvalidProtocolBufferException
  - popLimit
```
public void popLimit(int oldLimit)
```
    Discards the current limit, returning to the previous limit.
    
    Parameters:
    
    oldLimit - The old limit, as returned by pushLimit.
  - getBytesUntilLimit
```
public int getBytesUntilLimit()
```
    Returns the number of bytes to be read before the current limit. If no limit is set, returns -1.
  - isAtEnd
```
public abstract boolean isAtEnd()
                         throws IOException
```
    Returns true if the source 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 source has reached a limit created using pushLimit(int). This function may get blocked when using InputStream-backed streams as it tries to peek ahead.
    
    Throws:
    
    IOException
  - getTotalBytesRead
```
public abstract int getTotalBytesRead()
```
    The total bytes read up to the current position. Calling resetSizeCounter() resets this value to zero on supported implementations.
  - rewindTo
```
public abstract void rewindTo(int totalBytesRead)
```
    Rewinds the internal position to match the desired number of bytes read.
  - readRawByte
```
public abstract byte readRawByte()
                          throws IOException
```
    Read one byte from the input.
    
    Throws:
    
    InvalidProtocolBufferException - The end of the source or the current limit was reached.
    
    IOException
  - skipRawBytes
```
public abstract void skipRawBytes(int size)
                           throws IOException
```
    Reads and discards size bytes.
    
    Throws:
    
    InvalidProtocolBufferException - The end of the source or the current limit was reached.
    
    IOException
  - reserveRepeatedFieldCapacity
```
protected void reserveRepeatedFieldCapacity(us.hebi.quickbuf.RepeatedField<?,?> store,
                                            int tag)
                                     throws IOException
```
    Reserves space in the repeated field store to hold additional values. We assume that in the common case repeated fields are contiguously serialized, so we can look ahead to see how many values are remaining to avoid unnecessary allocations. Note that this is an optimization that may do nothing if looking ahead is not supported.
    
    Parameters:
    
    store - target store
    
    tag - tag of the contained repeated field
    
    Throws:
    
    IOException
  - reservePackedVarintCapacity
```
protected void reservePackedVarintCapacity(us.hebi.quickbuf.RepeatedField<?,?> store)
                                    throws IOException
```
    Reserves space in the repeated field store to hold the number of remaining varints until the limit or end of stream is reached. Note that this is an optimization that may do nothing if looking ahead is not supported.
    
    Parameters:
    
    store - target store
    
    Throws:
    
    IOException
  - readRawVarint32
```
public static int readRawVarint32(InputStream input)
                           throws IOException
```
    Reads a varint from the input one byte at a time, so that it does not read any bytes after the end of the varint. If you simply wrapped the stream in a StreamSource and used readRawVarint32() then you may end up reading too many bytes.
    
    Throws:
    
    IOException
  - readRawVarint32
```
public static int readRawVarint32(int firstByte,
                                  InputStream input)
                           throws IOException
```
    Like readRawVarint32(InputStream), but expects that the caller has already read one byte. This allows the caller to determine if EOF has been reached before attempting to read.
    
    Throws:
    
    IOException

Class ProtoSource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

recursionDepth

recursionLimit

currentLimit

NO_LIMIT

Constructor Detail

ProtoSource

Method Detail

newInstance

newInstance

newInstance

newInstance

newInstance

newArraySource

newDirectSource

newStreamSource

newBufferSource

setInput

setInput

setInput

setInput

setInput

clear

readTag

checkLastTagWas

skipField

skipField

skipEnum

skipMessage

skipMessage

readPackedDouble

readRawDoubles

readRepeatedDouble

readDouble

readPackedFloat

readRawFloats

readRepeatedFloat

readFloat

readPackedSFixed64

readPackedFixed64

readRawFixed64s

readRepeatedSFixed64

readRepeatedFixed64

readSFixed64

readFixed64

readPackedSFixed32

readPackedFixed32

readRawFixed32s

readRepeatedSFixed32

readRepeatedFixed32

readSFixed32

readFixed32

readPackedUInt64

readPackedInt64

readPackedSInt64

readRepeatedUInt64

readRepeatedInt64

readRepeatedSInt64

readUInt64

readInt64

readSInt64

readPackedUInt32

readPackedInt32

readPackedSInt32

readRepeatedUInt32

readRepeatedInt32

readRepeatedSInt32

readUInt32

readInt32

readSInt32

readPackedBool

readRepeatedBool

readBool

readPackedEnum

readRepeatedEnum