Class CodedInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
org.fusesource.hawtbuf.proto.CodedInputStream
All Implemented Interfaces:
Closeable, AutoCloseable
public final class CodedInputStream extends FilterInputStream
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 readRawBytes(int)). 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.

  • Field Details

    • lastTag

      private int lastTag

    • limit

      private int limit

    • pos

      private int pos

    • bis

      private BufferInputStream bis

  • Constructor Details

    • CodedInputStream

      public CodedInputStream(InputStream in)

    • CodedInputStream

      public CodedInputStream(Buffer data)

    • CodedInputStream

      public CodedInputStream(byte[] data)

  • Method Details

    • 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

    • 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

    • readDouble

      public double readDouble() throws IOException
      Read a double field value from the stream.
      Throws:
      IOException

    • readFloat

      public float readFloat() throws IOException
      Read a float field value from the stream.
      Throws:
      IOException

    • readUInt64

      public long readUInt64() throws IOException
      Read a uint64 field value from the stream.
      Throws:
      IOException

    • readInt64

      public long readInt64() throws IOException
      Read an int64 field value from the stream.
      Throws:
      IOException

    • readInt32

      public int readInt32() throws IOException
      Read an int32 field value from the stream.
      Throws:
      IOException

    • readFixed64

      public long readFixed64() throws IOException
      Read a fixed64 field value from the stream.
      Throws:
      IOException

    • readFixed32

      public int readFixed32() throws IOException
      Read a fixed32 field value from the stream.
      Throws:
      IOException

    • readBool

      public boolean readBool() throws IOException
      Read a bool field value from the stream.
      Throws:
      IOException

    • readString

      public String readString() throws IOException
      Read a string field value from the stream.
      Throws:
      IOException

    • readBytes

      public Buffer readBytes() throws IOException
      Read a bytes field value from the stream.
      Throws:
      IOException

    • readUInt32

      public int readUInt32() throws IOException
      Read a uint32 field value from the stream.
      Throws:
      IOException

    • readEnum

      public int readEnum() throws IOException
      Read an enum field value from the stream. Caller is responsible for converting the numeric value to an actual enum.
      Throws:
      IOException

    • readSFixed32

      public int readSFixed32() throws IOException
      Read an sfixed32 field value from the stream.
      Throws:
      IOException

    • readSFixed64

      public long readSFixed64() throws IOException
      Read an sfixed64 field value from the stream.
      Throws:
      IOException

    • readSInt32

      public int readSInt32() throws IOException
      Read an sint32 field value from the stream.
      Throws:
      IOException

    • readSInt64

      public long readSInt64() throws IOException
      Read an sint64 field value from the stream.
      Throws:
      IOException

    • readRawVarint32

      public int readRawVarint32() throws IOException
      Read a raw Varint from the stream. If larger than 32 bits, discard the upper bits.
      Throws:
      IOException

    • readRawVarint64

      public long readRawVarint64() throws IOException
      Read a raw Varint from the stream.
      Throws:
      IOException

    • readRawLittleEndian32

      public int readRawLittleEndian32() throws IOException
      Read a 32-bit little-endian integer from the stream.
      Throws:
      IOException

    • readRawLittleEndian64

      public long readRawLittleEndian64() throws IOException
      Read a 64-bit little-endian integer from the stream.
      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.

    • readRawByte

      public byte readRawByte() throws IOException
      Read one byte from the input.
      Throws:
      InvalidProtocolBufferException - The end of the stream or the current limit was reached.
      IOException

    • readRawBytes

      public Buffer readRawBytes(int size) throws IOException
      Read a fixed size of bytes from the input.
      Throws:
      InvalidProtocolBufferException - The end of the stream or the current limit was reached.
      IOException

    • skipRawBytes

      public void skipRawBytes(int size) throws IOException
      Reads and discards size bytes.
      Throws:
      InvalidProtocolBufferException - The end of the stream or the current limit was reached.
      IOException

    • pushLimit

      public int pushLimit(int limit)

    • popLimit

      public void popLimit(int limit)