|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.io.InputStream
java.io.FilterInputStream
org.fusesource.hawtbuf.proto.CodedInputStream
public final class CodedInputStream
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 Summary |
---|
Fields inherited from class java.io.FilterInputStream |
---|
in |
Constructor Summary | |
---|---|
CodedInputStream(Buffer data)
|
|
CodedInputStream(byte[] data)
|
|
CodedInputStream(java.io.InputStream in)
|
Method Summary | |
---|---|
void |
checkLastTagWas(int value)
Verifies that the last call to readTag() returned the given tag value. |
static int |
decodeZigZag32(int n)
Decode a ZigZag-encoded 32-bit value. |
static long |
decodeZigZag64(long n)
Decode a ZigZag-encoded 64-bit value. |
void |
popLimit(int limit)
|
int |
pushLimit(int limit)
|
boolean |
readBool()
Read a bool field value from the stream. |
Buffer |
readBytes()
Read a bytes field value from the stream. |
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. |
int |
readInt32()
Read an int32 field value from the stream. |
long |
readInt64()
Read an int64 field value from the stream. |
byte |
readRawByte()
Read one byte from the input. |
Buffer |
readRawBytes(int size)
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. |
long |
readRawVarint64()
Read a raw Varint from the stream. |
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. |
java.lang.String |
readString()
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. |
boolean |
skipField(int tag)
Reads and discards a single field, given its tag value. |
void |
skipMessage()
Reads and discards an entire message. |
void |
skipRawBytes(int size)
Reads and discards size bytes. |
Methods inherited from class java.io.FilterInputStream |
---|
available, close, mark, markSupported, read, read, read, reset, skip |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CodedInputStream(java.io.InputStream in)
public CodedInputStream(Buffer data)
public CodedInputStream(byte[] data)
Method Detail |
---|
public int readTag() throws java.io.IOException
java.io.IOException
public void checkLastTagWas(int value) throws InvalidProtocolBufferException
InvalidProtocolBufferException
- value
does not match the last tag.public boolean skipField(int tag) throws java.io.IOException
false
if the tag is an endgroup tag, in which case
nothing is skipped. Otherwise, returns true
.
java.io.IOException
public void skipMessage() throws java.io.IOException
java.io.IOException
public double readDouble() throws java.io.IOException
double
field value from the stream.
java.io.IOException
public float readFloat() throws java.io.IOException
float
field value from the stream.
java.io.IOException
public long readUInt64() throws java.io.IOException
uint64
field value from the stream.
java.io.IOException
public long readInt64() throws java.io.IOException
int64
field value from the stream.
java.io.IOException
public int readInt32() throws java.io.IOException
int32
field value from the stream.
java.io.IOException
public long readFixed64() throws java.io.IOException
fixed64
field value from the stream.
java.io.IOException
public int readFixed32() throws java.io.IOException
fixed32
field value from the stream.
java.io.IOException
public boolean readBool() throws java.io.IOException
bool
field value from the stream.
java.io.IOException
public java.lang.String readString() throws java.io.IOException
string
field value from the stream.
java.io.IOException
public Buffer readBytes() throws java.io.IOException
bytes
field value from the stream.
java.io.IOException
public int readUInt32() throws java.io.IOException
uint32
field value from the stream.
java.io.IOException
public int readEnum() throws java.io.IOException
java.io.IOException
public int readSFixed32() throws java.io.IOException
sfixed32
field value from the stream.
java.io.IOException
public long readSFixed64() throws java.io.IOException
sfixed64
field value from the stream.
java.io.IOException
public int readSInt32() throws java.io.IOException
sint32
field value from the stream.
java.io.IOException
public long readSInt64() throws java.io.IOException
sint64
field value from the stream.
java.io.IOException
public int readRawVarint32() throws java.io.IOException
java.io.IOException
public long readRawVarint64() throws java.io.IOException
java.io.IOException
public int readRawLittleEndian32() throws java.io.IOException
java.io.IOException
public long readRawLittleEndian64() throws java.io.IOException
java.io.IOException
public static int decodeZigZag32(int n)
n
- An unsigned 32-bit integer, stored in a signed int because
Java has no explicit unsigned support.
public static long decodeZigZag64(long n)
n
- An unsigned 64-bit integer, stored in a signed int because
Java has no explicit unsigned support.
public byte readRawByte() throws java.io.IOException
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.
java.io.IOException
public Buffer readRawBytes(int size) throws java.io.IOException
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.
java.io.IOException
public void skipRawBytes(int size) throws java.io.IOException
size
bytes.
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.
java.io.IOException
public int pushLimit(int limit)
public void popLimit(int limit)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |