ByteArrayInputEx (Java Chassis::Foundations::Protobuf 1.3.0 API)

java.lang.Object
- io.protostuff.ByteArrayInputEx

All Implemented Interfaces:

InputEx
```
public final class ByteArrayInputEx
extends Object
implements InputEx
```
Forked and modified from protostuff Reads and decodes protocol buffer message fields from an internal byte array buffer. This object is re-usable via doing a reset on the byte array position and length. This is used internally by IOUtil where it catches ArrayIndexOutOfBoundsException when a message is truncated.

Author:

David Yu

Date created:

Jun 22, 2010

Constructor Summary

Constructors
Constructor and Description

ByteArrayInputEx(byte[] buffer)

ByteArrayInputEx(byte[] buffer, int offset, int len)

Constructors
Constructor and Description
`ByteArrayInputEx(byte[] buffer)`
`ByteArrayInputEx(byte[] buffer, int offset, int len)`

Method Summary

All Methods Instance 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.
`com.fasterxml.jackson.databind.util.ArrayBuilders`	`getArrayBuilders()`
`void`	`handleUnknownField(int fieldNumber)` The underlying implementation should handle the unknown field.
`boolean`	`isCurrentFieldPacked()` Return true if currently reading packed field
`<T> T`	`mergeObject(T value, SchemaReader<T> schema)` Merges an object(with schema) field value.
`boolean`	`readBool()` Read a `bool` field value from the internal buffer.
`byte[]`	`readByteArray()` Reads a byte array field value.
`ByteBuffer`	`readByteBuffer()` Reads a byte array/ByteBuffer value.
`io.protostuff.ByteString`	`readBytes()` Reads a `ByteString` field value.
`double`	`readDouble()` Read a `double` field value from the internal buffer.
`int`	`readEnum()` Read an enum field value from the internal buffer.
`int`	`readFieldNumber()` Reads field number.
`int`	`readFixed32()` Read a `fixed32` field value from the internal buffer.
`long`	`readFixed64()` Read a `fixed64` field value from the internal buffer.
`float`	`readFloat()` Read a `float` field value from the internal buffer.
`int`	`readInt32()` Read an `int32` field value from the internal buffer.
`long`	`readInt64()` Read an `int64` field value from the internal buffer.
`boolean`	`readPackedBool()`
`double`	`readPackedDouble()`
`int`	`readPackedEnum()`
`int`	`readPackedFixed32()`
`long`	`readPackedFixed64()`
`float`	`readPackedFloat()`
`int`	`readPackedInt32()`
`long`	`readPackedInt64()`
`int`	`readPackedSFixed32()`
`long`	`readPackedSFixed64()`
`int`	`readPackedSInt32()`
`long`	`readPackedSInt64()`
`int`	`readPackedUInt32()`
`long`	`readPackedUInt64()`
`int`	`readRawLittleEndian32()` Read a 32-bit little-endian integer from the internal buffer.
`long`	`readRawLittleEndian64()` Read a 64-bit little-endian integer from the internal byte buffer.
`int`	`readRawVarint32()` Reads a var int 32 from the internal byte buffer.
`long`	`readRawVarint64()` Reads a var int 64 from the internal byte buffer.
`int`	`readSFixed32()` Read an `sfixed32` field value from the internal buffer.
`long`	`readSFixed64()` Read an `sfixed64` field value from the internal buffer.
`int`	`readSInt32()` Read an `sint32` field value from the internal buffer.
`long`	`readSInt64()` Read an `sint64` field value from the internal buffer.
`String`	`readString()` Reads a `String` field value.
`int`	`readTag()` Attempt to read a field tag, returning zero if we have reached EOF.
`int`	`readUInt32()` Read a `uint32` field value from the internal buffer.
`long`	`readUInt64()` Read a `uint64` field value from the internal buffer.
`boolean`	`skipField(int tag)` Reads and discards a single field, given its tag value.
`void`	`skipMessage()` Reads and discards an entire message.

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

- Constructor Detail
  - ByteArrayInputEx
```
public ByteArrayInputEx(byte[] buffer)
```
  - ByteArrayInputEx
```
public ByteArrayInputEx(byte[] buffer,
                        int offset,
                        int len)
```
- Method Detail
  - isCurrentFieldPacked
```
public boolean isCurrentFieldPacked()
```
    Return true if currently reading packed field
  - 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 io.protostuff.ProtobufException
```
    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:
    
    ProtobufException - 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
  - skipMessage
```
public 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
  - handleUnknownField
```
public void handleUnknownField(int fieldNumber)
                        throws IOException
```
    Description copied from interface: InputEx
    
    The underlying implementation should handle the unknown field.
    
    Specified by:
    
    handleUnknownField in interface InputEx
    
    Throws:
    
    IOException
  - readFieldNumber
```
public int readFieldNumber()
                    throws IOException
```
    Description copied from interface: InputEx
    
    Reads field number.
    
    Specified by:
    
    readFieldNumber in interface InputEx
    
    Throws:
    
    IOException
  - readDouble
```
public double readDouble()
```
    Read a double field value from the internal buffer.
    
    Specified by:
    
    readDouble in interface InputEx
  - readFloat
```
public float readFloat()
```
    Read a float field value from the internal buffer.
    
    Specified by:
    
    readFloat in interface InputEx
  - readUInt64
```
public long readUInt64()
                throws IOException
```
    Read a uint64 field value from the internal buffer.
    
    Specified by:
    
    readUInt64 in interface InputEx
    
    Throws:
    
    IOException
  - readInt64
```
public long readInt64()
               throws IOException
```
    Read an int64 field value from the internal buffer.
    
    Specified by:
    
    readInt64 in interface InputEx
    
    Throws:
    
    IOException
  - readInt32
```
public int readInt32()
              throws IOException
```
    Read an int32 field value from the internal buffer.
    
    Specified by:
    
    readInt32 in interface InputEx
    
    Throws:
    
    IOException
  - readFixed64
```
public long readFixed64()
```
    Read a fixed64 field value from the internal buffer.
    
    Specified by:
    
    readFixed64 in interface InputEx
  - readFixed32
```
public int readFixed32()
```
    Read a fixed32 field value from the internal buffer.
    
    Specified by:
    
    readFixed32 in interface InputEx
  - readBool
```
public boolean readBool()
```
    Read a bool field value from the internal buffer.
    
    Specified by:
    
    readBool in interface InputEx
  - readUInt32
```
public int readUInt32()
               throws IOException
```
    Read a uint32 field value from the internal buffer.
    
    Specified by:
    
    readUInt32 in interface InputEx
    
    Throws:
    
    IOException
  - readEnum
```
public int readEnum()
             throws IOException
```
    Read an enum field value from the internal buffer. Caller is responsible for converting the numeric value to an actual enum.
    
    Specified by:
    
    readEnum in interface InputEx
    
    Throws:
    
    IOException
  - readSFixed32
```
public int readSFixed32()
```
    Read an sfixed32 field value from the internal buffer.
    
    Specified by:
    
    readSFixed32 in interface InputEx
  - readSFixed64
```
public long readSFixed64()
```
    Read an sfixed64 field value from the internal buffer.
    
    Specified by:
    
    readSFixed64 in interface InputEx
  - readSInt32
```
public int readSInt32()
               throws IOException
```
    Read an sint32 field value from the internal buffer.
    
    Specified by:
    
    readSInt32 in interface InputEx
    
    Throws:
    
    IOException
  - readSInt64
```
public long readSInt64()
                throws IOException
```
    Read an sint64 field value from the internal buffer.
    
    Specified by:
    
    readSInt64 in interface InputEx
    
    Throws:
    
    IOException
  - readString
```
public String readString()
                  throws IOException
```
    Description copied from interface: InputEx
    
    Reads a String field value.
    
    Specified by:
    
    readString in interface InputEx
    
    Throws:
    
    IOException
  - readBytes
```
public io.protostuff.ByteString readBytes()
                                   throws IOException
```
    Description copied from interface: InputEx
    
    Reads a ByteString field value.
    
    Specified by:
    
    readBytes in interface InputEx
    
    Throws:
    
    IOException
  - readByteArray
```
public byte[] readByteArray()
                     throws IOException
```
    Description copied from interface: InputEx
    
    Reads a byte array field value.
    
    Specified by:
    
    readByteArray in interface InputEx
    
    Throws:
    
    IOException
  - mergeObject
```
public <T> T mergeObject(T value,
                         SchemaReader<T> schema)
                  throws IOException
```
    Description copied from interface: InputEx
    
    Merges an object(with schema) field value. The provided schema handles the deserialization for the object.
    
    Specified by:
    
    mergeObject in interface InputEx
    
    Throws:
    
    IOException
  - readRawVarint32
```
public int readRawVarint32()
                    throws IOException
```
    Reads a var int 32 from the internal byte buffer.
    
    Throws:
    
    IOException
  - readRawVarint64
```
public long readRawVarint64()
                     throws IOException
```
    Reads a var int 64 from the internal byte buffer.
    
    Throws:
    
    IOException
  - readRawLittleEndian32
```
public int readRawLittleEndian32()
```
    Read a 32-bit little-endian integer from the internal buffer.
  - readRawLittleEndian64
```
public long readRawLittleEndian64()
```
    Read a 64-bit little-endian integer from the internal byte buffer.
  - readByteBuffer
```
public ByteBuffer readByteBuffer()
                          throws IOException
```
    Reads a byte array/ByteBuffer value.
    
    Specified by:
    
    readByteBuffer in interface InputEx
    
    Throws:
    
    IOException
  - getArrayBuilders
```
public com.fasterxml.jackson.databind.util.ArrayBuilders getArrayBuilders()
```
    Specified by:
    
    getArrayBuilders in interface InputEx
  - readPackedInt32
```
public int readPackedInt32()
                    throws IOException
```
    Specified by:
    
    readPackedInt32 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedUInt32
```
public int readPackedUInt32()
                     throws IOException
```
    Specified by:
    
    readPackedUInt32 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedSInt32
```
public int readPackedSInt32()
                     throws IOException
```
    Specified by:
    
    readPackedSInt32 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedFixed32
```
public int readPackedFixed32()
                      throws IOException
```
    Specified by:
    
    readPackedFixed32 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedSFixed32
```
public int readPackedSFixed32()
                       throws IOException
```
    Specified by:
    
    readPackedSFixed32 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedInt64
```
public long readPackedInt64()
                     throws IOException
```
    Specified by:
    
    readPackedInt64 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedUInt64
```
public long readPackedUInt64()
                      throws IOException
```
    Specified by:
    
    readPackedUInt64 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedSInt64
```
public long readPackedSInt64()
                      throws IOException
```
    Specified by:
    
    readPackedSInt64 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedFixed64
```
public long readPackedFixed64()
                       throws IOException
```
    Specified by:
    
    readPackedFixed64 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedSFixed64
```
public long readPackedSFixed64()
                        throws IOException
```
    Specified by:
    
    readPackedSFixed64 in interface InputEx
    
    Throws:
    
    IOException
  - readPackedFloat
```
public float readPackedFloat()
                      throws IOException
```
    Specified by:
    
    readPackedFloat in interface InputEx
    
    Throws:
    
    IOException
  - readPackedDouble
```
public double readPackedDouble()
                        throws IOException
```
    Specified by:
    
    readPackedDouble in interface InputEx
    
    Throws:
    
    IOException
  - readPackedBool
```
public boolean readPackedBool()
                       throws IOException
```
    Specified by:
    
    readPackedBool in interface InputEx
    
    Throws:
    
    IOException
  - readPackedEnum
```
public int readPackedEnum()
                   throws IOException
```
    Specified by:
    
    readPackedEnum in interface InputEx
    
    Throws:
    
    IOException

Class ByteArrayInputEx

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteArrayInputEx

ByteArrayInputEx

Method Detail

isCurrentFieldPacked

readTag

checkLastTagWas

skipField

skipMessage

handleUnknownField

readFieldNumber

readDouble

readFloat

readUInt64

readInt64

readInt32

readFixed64

readFixed32

readBool

readUInt32

readEnum

readSFixed32

readSFixed64

readSInt32

readSInt64

readString

readBytes

readByteArray

mergeObject

readRawVarint32

readRawVarint64

readRawLittleEndian32

readRawLittleEndian64

readByteBuffer

getArrayBuilders

readPackedInt32

readPackedUInt32

readPackedSInt32

readPackedFixed32

readPackedSFixed32

readPackedInt64

readPackedUInt64

readPackedSInt64

readPackedFixed64

readPackedSFixed64

readPackedFloat

readPackedDouble

readPackedBool

readPackedEnum