public abstract class CodedInputStream
extends java.lang.Object
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.
Modifier and Type | Method and Description |
---|---|
abstract 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.
|
abstract void |
enableAliasing(boolean enabled)
Enables
ByteString aliasing of the underlying buffer, trading off on buffer pinning for
data copies. |
abstract int |
getBytesUntilLimit()
Returns the number of bytes to be read before the current limit.
|
abstract int |
getLastTag() |
abstract int |
getTotalBytesRead()
The total bytes read up to the current position.
|
abstract boolean |
isAtEnd()
Returns true if the stream has reached the end of the input.
|
static CodedInputStream |
newInstance(byte[] buf)
Create a new CodedInputStream wrapping the given byte array.
|
static CodedInputStream |
newInstance(byte[] buf,
int off,
int len)
Create a new CodedInputStream wrapping the given byte array slice.
|
static CodedInputStream |
newInstance(java.nio.ByteBuffer buf)
Create a new CodedInputStream wrapping the given ByteBuffer.
|
static CodedInputStream |
newInstance(java.io.InputStream input)
Create a new CodedInputStream wrapping the given InputStream.
|
static CodedInputStream |
newInstance(java.io.InputStream input,
int bufferSize)
Create a new CodedInputStream wrapping the given InputStream, with a specified buffer size.
|
static CodedInputStream |
newInstance(java.lang.Iterable<java.nio.ByteBuffer> input)
Create a new CodedInputStream wrapping the given
Iterable <ByteBuffer> . |
abstract void |
popLimit(int oldLimit)
Discards the current limit, returning to the previous limit.
|
abstract int |
pushLimit(int byteLimit)
Sets
currentLimit to (current position) + byteLimit . |
abstract boolean |
readBool()
Read a
bool field value from the stream. |
abstract byte[] |
readByteArray()
Read a
bytes field value from the stream. |
abstract java.nio.ByteBuffer |
readByteBuffer()
Read a
bytes field value from the stream. |
abstract ByteString |
readBytes()
Read a
bytes field value from the stream. |
abstract double |
readDouble()
Read a
double field value from the stream. |
abstract int |
readEnum()
Read an enum field value from the stream.
|
abstract int |
readFixed32()
Read a
fixed32 field value from the stream. |
abstract long |
readFixed64()
Read a
fixed64 field value from the stream. |
abstract float |
readFloat()
Read a
float field value from the stream. |
abstract void |
readGroup(int fieldNumber,
MessageLite.Builder builder,
ExtensionRegistryLite extensionRegistry)
Read a
group field value from the stream. |
abstract <T extends MessageLite> |
readGroup(int fieldNumber,
Parser<T> parser,
ExtensionRegistryLite extensionRegistry)
Read a
group field value from the stream. |
abstract int |
readInt32()
Read an
int32 field value from the stream. |
abstract long |
readInt64()
Read an
int64 field value from the stream. |
abstract void |
readMessage(MessageLite.Builder builder,
ExtensionRegistryLite extensionRegistry)
Read an embedded message field value from the stream.
|
abstract <T extends MessageLite> |
readMessage(Parser<T> parser,
ExtensionRegistryLite extensionRegistry)
Read an embedded message field value from the stream.
|
abstract byte |
readRawByte()
Read one byte from the input.
|
abstract byte[] |
readRawBytes(int size)
Read a fixed size of bytes from the input.
|
abstract int |
readRawLittleEndian32()
Read a 32-bit little-endian integer from the stream.
|
abstract long |
readRawLittleEndian64()
Read a 64-bit little-endian integer from the stream.
|
abstract int |
readRawVarint32()
Read a raw Varint from the stream.
|
static int |
readRawVarint32(int firstByte,
java.io.InputStream input)
Like
readRawVarint32(InputStream) , but expects that the caller has already read one
byte. |
abstract long |
readRawVarint64()
Read a raw Varint from the stream.
|
abstract int |
readSFixed32()
Read an
sfixed32 field value from the stream. |
abstract long |
readSFixed64()
Read an
sfixed64 field value from the stream. |
abstract int |
readSInt32()
Read an
sint32 field value from the stream. |
abstract long |
readSInt64()
Read an
sint64 field value from the stream. |
abstract java.lang.String |
readString()
Read a
string field value from the stream. |
abstract java.lang.String |
readStringRequireUtf8()
Read a
string field value from the stream. |
abstract int |
readTag()
Attempt to read a field tag, returning zero if we have reached EOF.
|
abstract int |
readUInt32()
Read a
uint32 field value from the stream. |
abstract long |
readUInt64()
Read a
uint64 field value from the stream. |
abstract void |
readUnknownGroup(int fieldNumber,
MessageLite.Builder builder)
Deprecated.
UnknownFieldSet.Builder now implements MessageLite.Builder, so you can just call
readGroup(int, org.apache.flink.statefun.sdk.shaded.com.google.protobuf.MessageLite.Builder, org.apache.flink.statefun.sdk.shaded.com.google.protobuf.ExtensionRegistryLite) . |
abstract void |
resetSizeCounter()
Resets the current size counter to zero (see
setSizeLimit(int) ). |
int |
setRecursionLimit(int limit)
Set the maximum message recursion depth.
|
int |
setSizeLimit(int limit)
Only valid for
InputStream -backed streams. |
abstract boolean |
skipField(int tag)
Reads and discards a single field, given its tag value.
|
abstract boolean |
skipField(int tag,
CodedOutputStream output)
Deprecated.
use
UnknownFieldSet or UnknownFieldSetLite to skip to an output
stream. |
abstract void |
skipMessage()
Reads and discards an entire message.
|
abstract void |
skipMessage(CodedOutputStream output)
Reads an entire message and writes it to output in wire format.
|
abstract void |
skipRawBytes(int size)
Reads and discards
size bytes. |
public static CodedInputStream newInstance(java.io.InputStream input)
public static CodedInputStream newInstance(java.io.InputStream input, int bufferSize)
public static CodedInputStream newInstance(java.lang.Iterable<java.nio.ByteBuffer> input)
Iterable <ByteBuffer>
.public static CodedInputStream newInstance(byte[] buf)
public static CodedInputStream newInstance(byte[] buf, int off, int len)
public static CodedInputStream newInstance(java.nio.ByteBuffer buf)
public abstract int readTag() throws java.io.IOException
java.io.IOException
public abstract void checkLastTagWas(int value) throws InvalidProtocolBufferException
InvalidProtocolBufferException
- value
does not match the last tag.public abstract int getLastTag()
public abstract 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
@Deprecated public abstract boolean skipField(int tag, CodedOutputStream output) throws java.io.IOException
UnknownFieldSet
or UnknownFieldSetLite
to skip to an output
stream.false
if the tag is an endgroup tag, in which case nothing is skipped.
Otherwise, returns true
.java.io.IOException
public abstract void skipMessage() throws java.io.IOException
java.io.IOException
public abstract void skipMessage(CodedOutputStream output) throws java.io.IOException
java.io.IOException
public abstract double readDouble() throws java.io.IOException
double
field value from the stream.java.io.IOException
public abstract float readFloat() throws java.io.IOException
float
field value from the stream.java.io.IOException
public abstract long readUInt64() throws java.io.IOException
uint64
field value from the stream.java.io.IOException
public abstract long readInt64() throws java.io.IOException
int64
field value from the stream.java.io.IOException
public abstract int readInt32() throws java.io.IOException
int32
field value from the stream.java.io.IOException
public abstract long readFixed64() throws java.io.IOException
fixed64
field value from the stream.java.io.IOException
public abstract int readFixed32() throws java.io.IOException
fixed32
field value from the stream.java.io.IOException
public abstract boolean readBool() throws java.io.IOException
bool
field value from the stream.java.io.IOException
public abstract java.lang.String readString() throws java.io.IOException
string
field value from the stream. If the stream contains malformed UTF-8,
replace the offending bytes with the standard UTF-8 replacement character.java.io.IOException
public abstract java.lang.String readStringRequireUtf8() throws java.io.IOException
string
field value from the stream. If the stream contains malformed UTF-8,
throw exception InvalidProtocolBufferException
.java.io.IOException
public abstract void readGroup(int fieldNumber, MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
group
field value from the stream.java.io.IOException
public abstract <T extends MessageLite> T readGroup(int fieldNumber, Parser<T> parser, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
group
field value from the stream.java.io.IOException
@Deprecated public abstract void readUnknownGroup(int fieldNumber, MessageLite.Builder builder) throws java.io.IOException
readGroup(int, org.apache.flink.statefun.sdk.shaded.com.google.protobuf.MessageLite.Builder, org.apache.flink.statefun.sdk.shaded.com.google.protobuf.ExtensionRegistryLite)
.group
field value from the stream and merges it into the given UnknownFieldSet
.java.io.IOException
public abstract void readMessage(MessageLite.Builder builder, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public abstract <T extends MessageLite> T readMessage(Parser<T> parser, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public abstract ByteString readBytes() throws java.io.IOException
bytes
field value from the stream.java.io.IOException
public abstract byte[] readByteArray() throws java.io.IOException
bytes
field value from the stream.java.io.IOException
public abstract java.nio.ByteBuffer readByteBuffer() throws java.io.IOException
bytes
field value from the stream.java.io.IOException
public abstract int readUInt32() throws java.io.IOException
uint32
field value from the stream.java.io.IOException
public abstract int readEnum() throws java.io.IOException
java.io.IOException
public abstract int readSFixed32() throws java.io.IOException
sfixed32
field value from the stream.java.io.IOException
public abstract long readSFixed64() throws java.io.IOException
sfixed64
field value from the stream.java.io.IOException
public abstract int readSInt32() throws java.io.IOException
sint32
field value from the stream.java.io.IOException
public abstract long readSInt64() throws java.io.IOException
sint64
field value from the stream.java.io.IOException
public abstract int readRawVarint32() throws java.io.IOException
java.io.IOException
public abstract long readRawVarint64() throws java.io.IOException
java.io.IOException
public abstract int readRawLittleEndian32() throws java.io.IOException
java.io.IOException
public abstract long readRawLittleEndian64() throws java.io.IOException
java.io.IOException
public abstract void enableAliasing(boolean enabled)
ByteString
aliasing of the underlying buffer, trading off on buffer pinning for
data copies. Only valid for buffer-backed streams.public final int setRecursionLimit(int limit)
CodedInputStream
limits how deeply messages may be nested. The default
limit is 100.public final int setSizeLimit(int limit)
InputStream
-backed streams.
Set the maximum message size. In order to prevent malicious messages from exhausting memory
or causing integer overflows, CodedInputStream
limits how large a message may be. The
default limit is Integer.MAX_INT
. 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.
public abstract void resetSizeCounter()
setSizeLimit(int)
). Only valid for InputStream
-backed streams.public abstract int pushLimit(int byteLimit) throws InvalidProtocolBufferException
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.
InvalidProtocolBufferException
public abstract void popLimit(int oldLimit)
oldLimit
- The old limit, as returned by pushLimit
.public abstract int getBytesUntilLimit()
public abstract boolean isAtEnd() throws java.io.IOException
pushLimit(int)
.java.io.IOException
public abstract int getTotalBytesRead()
resetSizeCounter()
resets
this value to zero.public abstract byte readRawByte() throws java.io.IOException
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.java.io.IOException
public abstract byte[] readRawBytes(int size) throws java.io.IOException
InvalidProtocolBufferException
- The end of the stream or the current limit was reached.java.io.IOException
public abstract 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 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 static int readRawVarint32(int firstByte, java.io.InputStream input) throws java.io.IOException
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.java.io.IOException
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.