public final class CodedOutputStream
extends java.lang.Object
This class contains two kinds of methods: methods that write specific
protocol message constructs and field types (e.g. writeTag(int, int)
and
writeInt32(int, int)
) and methods that write low-level values (e.g.
writeRawVarint32(int)
and writeRawBytes(com.google.protobuf.ByteString)
). If you are
writing encoded protocol messages, you should use the former methods, but if
you are writing some other format of your own design, use the latter.
This class is totally unsynchronized.
Modifier and Type | Class and Description |
---|---|
static class |
CodedOutputStream.OutOfSpaceException
If you create a CodedOutputStream around a simple flat array, you must
not attempt to write more bytes than the array has space.
|
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_BUFFER_SIZE
The buffer size used in
newInstance(OutputStream) . |
static int |
LITTLE_ENDIAN_32_SIZE |
static int |
LITTLE_ENDIAN_64_SIZE |
Modifier and Type | Method and Description |
---|---|
void |
checkNoSpaceLeft()
Verifies that
spaceLeft() returns zero. |
static int |
computeBoolSize(int fieldNumber,
boolean value)
Compute the number of bytes that would be needed to encode a
bool field, including tag. |
static int |
computeBoolSizeNoTag(boolean value)
Compute the number of bytes that would be needed to encode a
bool field. |
static int |
computeBytesSize(int fieldNumber,
ByteString value)
Compute the number of bytes that would be needed to encode a
bytes field, including tag. |
static int |
computeBytesSizeNoTag(ByteString value)
Compute the number of bytes that would be needed to encode a
bytes field. |
static int |
computeDoubleSize(int fieldNumber,
double value)
Compute the number of bytes that would be needed to encode a
double field, including tag. |
static int |
computeDoubleSizeNoTag(double value)
Compute the number of bytes that would be needed to encode a
double field, including tag. |
static int |
computeEnumSize(int fieldNumber,
int value)
Compute the number of bytes that would be needed to encode an
enum field, including tag.
|
static int |
computeEnumSizeNoTag(int value)
Compute the number of bytes that would be needed to encode an enum field.
|
static int |
computeFixed32Size(int fieldNumber,
int value)
Compute the number of bytes that would be needed to encode a
fixed32 field, including tag. |
static int |
computeFixed32SizeNoTag(int value)
Compute the number of bytes that would be needed to encode a
fixed32 field. |
static int |
computeFixed64Size(int fieldNumber,
long value)
Compute the number of bytes that would be needed to encode a
fixed64 field, including tag. |
static int |
computeFixed64SizeNoTag(long value)
Compute the number of bytes that would be needed to encode a
fixed64 field. |
static int |
computeFloatSize(int fieldNumber,
float value)
Compute the number of bytes that would be needed to encode a
float field, including tag. |
static int |
computeFloatSizeNoTag(float value)
Compute the number of bytes that would be needed to encode a
float field, including tag. |
static int |
computeGroupSize(int fieldNumber,
MessageLite value)
Compute the number of bytes that would be needed to encode a
group field, including tag. |
static int |
computeGroupSizeNoTag(MessageLite value)
Compute the number of bytes that would be needed to encode a
group field. |
static int |
computeInt32Size(int fieldNumber,
int value)
Compute the number of bytes that would be needed to encode an
int32 field, including tag. |
static int |
computeInt32SizeNoTag(int value)
Compute the number of bytes that would be needed to encode an
int32 field, including tag. |
static int |
computeInt64Size(int fieldNumber,
long value)
Compute the number of bytes that would be needed to encode an
int64 field, including tag. |
static int |
computeInt64SizeNoTag(long value)
Compute the number of bytes that would be needed to encode an
int64 field, including tag. |
static int |
computeLazyFieldMessageSetExtensionSize(int fieldNumber,
com.google.protobuf.LazyField value)
Compute the number of bytes that would be needed to encode an
lazily parsed MessageSet extension field to the stream.
|
static int |
computeLazyFieldSize(int fieldNumber,
com.google.protobuf.LazyField value)
Compute the number of bytes that would be needed to encode an
embedded message in lazy field, including tag.
|
static int |
computeLazyFieldSizeNoTag(com.google.protobuf.LazyField value)
Compute the number of bytes that would be needed to encode an embedded
message stored in lazy field.
|
static int |
computeMessageSetExtensionSize(int fieldNumber,
MessageLite value)
Compute the number of bytes that would be needed to encode a
MessageSet extension to the stream.
|
static int |
computeMessageSize(int fieldNumber,
MessageLite value)
Compute the number of bytes that would be needed to encode an
embedded message field, including tag.
|
static int |
computeMessageSizeNoTag(MessageLite value)
Compute the number of bytes that would be needed to encode an embedded
message field.
|
static int |
computeRawMessageSetExtensionSize(int fieldNumber,
ByteString value)
Compute the number of bytes that would be needed to encode an
unparsed MessageSet extension field to the stream.
|
static int |
computeRawVarint32Size(int value)
Compute the number of bytes that would be needed to encode a varint.
|
static int |
computeRawVarint64Size(long value)
Compute the number of bytes that would be needed to encode a varint.
|
static int |
computeSFixed32Size(int fieldNumber,
int value)
Compute the number of bytes that would be needed to encode an
sfixed32 field, including tag. |
static int |
computeSFixed32SizeNoTag(int value)
Compute the number of bytes that would be needed to encode an
sfixed32 field. |
static int |
computeSFixed64Size(int fieldNumber,
long value)
Compute the number of bytes that would be needed to encode an
sfixed64 field, including tag. |
static int |
computeSFixed64SizeNoTag(long value)
Compute the number of bytes that would be needed to encode an
sfixed64 field. |
static int |
computeSInt32Size(int fieldNumber,
int value)
Compute the number of bytes that would be needed to encode an
sint32 field, including tag. |
static int |
computeSInt32SizeNoTag(int value)
Compute the number of bytes that would be needed to encode an
sint32 field. |
static int |
computeSInt64Size(int fieldNumber,
long value)
Compute the number of bytes that would be needed to encode an
sint64 field, including tag. |
static int |
computeSInt64SizeNoTag(long value)
Compute the number of bytes that would be needed to encode an
sint64 field. |
static int |
computeStringSize(int fieldNumber,
java.lang.String value)
Compute the number of bytes that would be needed to encode a
string field, including tag. |
static int |
computeStringSizeNoTag(java.lang.String value)
Compute the number of bytes that would be needed to encode a
string field. |
static int |
computeTagSize(int fieldNumber)
Compute the number of bytes that would be needed to encode a tag.
|
static int |
computeUInt32Size(int fieldNumber,
int value)
Compute the number of bytes that would be needed to encode a
uint32 field, including tag. |
static int |
computeUInt32SizeNoTag(int value)
Compute the number of bytes that would be needed to encode a
uint32 field. |
static int |
computeUInt64Size(int fieldNumber,
long value)
Compute the number of bytes that would be needed to encode a
uint64 field, including tag. |
static int |
computeUInt64SizeNoTag(long value)
Compute the number of bytes that would be needed to encode a
uint64 field, including tag. |
static int |
computeUnknownGroupSize(int fieldNumber,
MessageLite value)
Deprecated.
UnknownFieldSet now implements MessageLite, so you can just
call
computeGroupSize(int, com.google.protobuf.MessageLite) . |
static int |
computeUnknownGroupSizeNoTag(MessageLite value)
Deprecated.
UnknownFieldSet now implements MessageLite, so you can just
call
computeUnknownGroupSizeNoTag(com.google.protobuf.MessageLite) . |
static int |
encodeZigZag32(int n)
Encode a ZigZag-encoded 32-bit value.
|
static long |
encodeZigZag64(long n)
Encode a ZigZag-encoded 64-bit value.
|
void |
flush()
Flushes the stream and forces any buffered bytes to be written.
|
static CodedOutputStream |
newInstance(byte[] flatArray)
Create a new
CodedOutputStream that writes directly to the given
byte array. |
static CodedOutputStream |
newInstance(byte[] flatArray,
int offset,
int length)
Create a new
CodedOutputStream that writes directly to the given
byte array slice. |
static CodedOutputStream |
newInstance(java.io.OutputStream output)
Create a new
CodedOutputStream wrapping the given
OutputStream . |
static CodedOutputStream |
newInstance(java.io.OutputStream output,
int bufferSize)
Create a new
CodedOutputStream wrapping the given
OutputStream with a given buffer size. |
int |
spaceLeft()
If writing to a flat array, return the space left in the array.
|
void |
writeBool(int fieldNumber,
boolean value)
Write a
bool field, including tag, to the stream. |
void |
writeBoolNoTag(boolean value)
Write a
bool field to the stream. |
void |
writeBytes(int fieldNumber,
ByteString value)
Write a
bytes field, including tag, to the stream. |
void |
writeBytesNoTag(ByteString value)
Write a
bytes field to the stream. |
void |
writeDouble(int fieldNumber,
double value)
Write a
double field, including tag, to the stream. |
void |
writeDoubleNoTag(double value)
Write a
double field to the stream. |
void |
writeEnum(int fieldNumber,
int value)
Write an enum field, including tag, to the stream.
|
void |
writeEnumNoTag(int value)
Write an enum field to the stream.
|
void |
writeFixed32(int fieldNumber,
int value)
Write a
fixed32 field, including tag, to the stream. |
void |
writeFixed32NoTag(int value)
Write a
fixed32 field to the stream. |
void |
writeFixed64(int fieldNumber,
long value)
Write a
fixed64 field, including tag, to the stream. |
void |
writeFixed64NoTag(long value)
Write a
fixed64 field to the stream. |
void |
writeFloat(int fieldNumber,
float value)
Write a
float field, including tag, to the stream. |
void |
writeFloatNoTag(float value)
Write a
float field to the stream. |
void |
writeGroup(int fieldNumber,
MessageLite value)
Write a
group field, including tag, to the stream. |
void |
writeGroupNoTag(MessageLite value)
Write a
group field to the stream. |
void |
writeInt32(int fieldNumber,
int value)
Write an
int32 field, including tag, to the stream. |
void |
writeInt32NoTag(int value)
Write an
int32 field to the stream. |
void |
writeInt64(int fieldNumber,
long value)
Write an
int64 field, including tag, to the stream. |
void |
writeInt64NoTag(long value)
Write an
int64 field to the stream. |
void |
writeMessage(int fieldNumber,
MessageLite value)
Write an embedded message field, including tag, to the stream.
|
void |
writeMessageNoTag(MessageLite value)
Write an embedded message field to the stream.
|
void |
writeMessageSetExtension(int fieldNumber,
MessageLite value)
Write a MessageSet extension field to the stream.
|
void |
writeRawByte(byte value)
Write a single byte.
|
void |
writeRawByte(int value)
Write a single byte, represented by an integer value.
|
void |
writeRawBytes(byte[] value)
Write an array of bytes.
|
void |
writeRawBytes(byte[] value,
int offset,
int length)
Write part of an array of bytes.
|
void |
writeRawBytes(ByteString value)
Write a byte string.
|
void |
writeRawBytes(ByteString value,
int offset,
int length)
Write part of a byte string.
|
void |
writeRawLittleEndian32(int value)
Write a little-endian 32-bit integer.
|
void |
writeRawLittleEndian64(long value)
Write a little-endian 64-bit integer.
|
void |
writeRawMessageSetExtension(int fieldNumber,
ByteString value)
Write an unparsed MessageSet extension field to the stream.
|
void |
writeRawVarint32(int value)
Encode and write a varint.
|
void |
writeRawVarint64(long value)
Encode and write a varint.
|
void |
writeSFixed32(int fieldNumber,
int value)
Write an
sfixed32 field, including tag, to the stream. |
void |
writeSFixed32NoTag(int value)
Write an
sfixed32 field to the stream. |
void |
writeSFixed64(int fieldNumber,
long value)
Write an
sfixed64 field, including tag, to the stream. |
void |
writeSFixed64NoTag(long value)
Write an
sfixed64 field to the stream. |
void |
writeSInt32(int fieldNumber,
int value)
Write an
sint32 field, including tag, to the stream. |
void |
writeSInt32NoTag(int value)
Write an
sint32 field to the stream. |
void |
writeSInt64(int fieldNumber,
long value)
Write an
sint64 field, including tag, to the stream. |
void |
writeSInt64NoTag(long value)
Write an
sint64 field to the stream. |
void |
writeString(int fieldNumber,
java.lang.String value)
Write a
string field, including tag, to the stream. |
void |
writeStringNoTag(java.lang.String value)
Write a
string field to the stream. |
void |
writeTag(int fieldNumber,
int wireType)
Encode and write a tag.
|
void |
writeUInt32(int fieldNumber,
int value)
Write a
uint32 field, including tag, to the stream. |
void |
writeUInt32NoTag(int value)
Write a
uint32 field to the stream. |
void |
writeUInt64(int fieldNumber,
long value)
Write a
uint64 field, including tag, to the stream. |
void |
writeUInt64NoTag(long value)
Write a
uint64 field to the stream. |
void |
writeUnknownGroup(int fieldNumber,
MessageLite value)
Deprecated.
UnknownFieldSet now implements MessageLite, so you can just
call
writeGroup(int, com.google.protobuf.MessageLite) . |
void |
writeUnknownGroupNoTag(MessageLite value)
Deprecated.
UnknownFieldSet now implements MessageLite, so you can just
call
writeGroupNoTag(com.google.protobuf.MessageLite) . |
public static final int DEFAULT_BUFFER_SIZE
newInstance(OutputStream)
.public static final int LITTLE_ENDIAN_32_SIZE
public static final int LITTLE_ENDIAN_64_SIZE
public static CodedOutputStream newInstance(java.io.OutputStream output)
CodedOutputStream
wrapping the given
OutputStream
.public static CodedOutputStream newInstance(java.io.OutputStream output, int bufferSize)
CodedOutputStream
wrapping the given
OutputStream
with a given buffer size.public static CodedOutputStream newInstance(byte[] flatArray)
CodedOutputStream
that writes directly to the given
byte array. If more bytes are written than fit in the array,
CodedOutputStream.OutOfSpaceException
will be thrown. Writing directly to a flat
array is faster than writing to an OutputStream
. See also
ByteString.newCodedBuilder(int)
.public static CodedOutputStream newInstance(byte[] flatArray, int offset, int length)
CodedOutputStream
that writes directly to the given
byte array slice. If more bytes are written than fit in the slice,
CodedOutputStream.OutOfSpaceException
will be thrown. Writing directly to a flat
array is faster than writing to an OutputStream
. See also
ByteString.newCodedBuilder(int)
.public void writeDouble(int fieldNumber, double value) throws java.io.IOException
double
field, including tag, to the stream.java.io.IOException
public void writeFloat(int fieldNumber, float value) throws java.io.IOException
float
field, including tag, to the stream.java.io.IOException
public void writeUInt64(int fieldNumber, long value) throws java.io.IOException
uint64
field, including tag, to the stream.java.io.IOException
public void writeInt64(int fieldNumber, long value) throws java.io.IOException
int64
field, including tag, to the stream.java.io.IOException
public void writeInt32(int fieldNumber, int value) throws java.io.IOException
int32
field, including tag, to the stream.java.io.IOException
public void writeFixed64(int fieldNumber, long value) throws java.io.IOException
fixed64
field, including tag, to the stream.java.io.IOException
public void writeFixed32(int fieldNumber, int value) throws java.io.IOException
fixed32
field, including tag, to the stream.java.io.IOException
public void writeBool(int fieldNumber, boolean value) throws java.io.IOException
bool
field, including tag, to the stream.java.io.IOException
public void writeString(int fieldNumber, java.lang.String value) throws java.io.IOException
string
field, including tag, to the stream.java.io.IOException
public void writeGroup(int fieldNumber, MessageLite value) throws java.io.IOException
group
field, including tag, to the stream.java.io.IOException
@Deprecated public void writeUnknownGroup(int fieldNumber, MessageLite value) throws java.io.IOException
writeGroup(int, com.google.protobuf.MessageLite)
.UnknownFieldSet
.java.io.IOException
public void writeMessage(int fieldNumber, MessageLite value) throws java.io.IOException
java.io.IOException
public void writeBytes(int fieldNumber, ByteString value) throws java.io.IOException
bytes
field, including tag, to the stream.java.io.IOException
public void writeUInt32(int fieldNumber, int value) throws java.io.IOException
uint32
field, including tag, to the stream.java.io.IOException
public void writeEnum(int fieldNumber, int value) throws java.io.IOException
java.io.IOException
public void writeSFixed32(int fieldNumber, int value) throws java.io.IOException
sfixed32
field, including tag, to the stream.java.io.IOException
public void writeSFixed64(int fieldNumber, long value) throws java.io.IOException
sfixed64
field, including tag, to the stream.java.io.IOException
public void writeSInt32(int fieldNumber, int value) throws java.io.IOException
sint32
field, including tag, to the stream.java.io.IOException
public void writeSInt64(int fieldNumber, long value) throws java.io.IOException
sint64
field, including tag, to the stream.java.io.IOException
public void writeMessageSetExtension(int fieldNumber, MessageLite value) throws java.io.IOException
java.io.IOException
public void writeRawMessageSetExtension(int fieldNumber, ByteString value) throws java.io.IOException
java.io.IOException
public void writeDoubleNoTag(double value) throws java.io.IOException
double
field to the stream.java.io.IOException
public void writeFloatNoTag(float value) throws java.io.IOException
float
field to the stream.java.io.IOException
public void writeUInt64NoTag(long value) throws java.io.IOException
uint64
field to the stream.java.io.IOException
public void writeInt64NoTag(long value) throws java.io.IOException
int64
field to the stream.java.io.IOException
public void writeInt32NoTag(int value) throws java.io.IOException
int32
field to the stream.java.io.IOException
public void writeFixed64NoTag(long value) throws java.io.IOException
fixed64
field to the stream.java.io.IOException
public void writeFixed32NoTag(int value) throws java.io.IOException
fixed32
field to the stream.java.io.IOException
public void writeBoolNoTag(boolean value) throws java.io.IOException
bool
field to the stream.java.io.IOException
public void writeStringNoTag(java.lang.String value) throws java.io.IOException
string
field to the stream.java.io.IOException
public void writeGroupNoTag(MessageLite value) throws java.io.IOException
group
field to the stream.java.io.IOException
@Deprecated public void writeUnknownGroupNoTag(MessageLite value) throws java.io.IOException
writeGroupNoTag(com.google.protobuf.MessageLite)
.UnknownFieldSet
.java.io.IOException
public void writeMessageNoTag(MessageLite value) throws java.io.IOException
java.io.IOException
public void writeBytesNoTag(ByteString value) throws java.io.IOException
bytes
field to the stream.java.io.IOException
public void writeUInt32NoTag(int value) throws java.io.IOException
uint32
field to the stream.java.io.IOException
public void writeEnumNoTag(int value) throws java.io.IOException
java.io.IOException
public void writeSFixed32NoTag(int value) throws java.io.IOException
sfixed32
field to the stream.java.io.IOException
public void writeSFixed64NoTag(long value) throws java.io.IOException
sfixed64
field to the stream.java.io.IOException
public void writeSInt32NoTag(int value) throws java.io.IOException
sint32
field to the stream.java.io.IOException
public void writeSInt64NoTag(long value) throws java.io.IOException
sint64
field to the stream.java.io.IOException
public static int computeDoubleSize(int fieldNumber, double value)
double
field, including tag.public static int computeFloatSize(int fieldNumber, float value)
float
field, including tag.public static int computeUInt64Size(int fieldNumber, long value)
uint64
field, including tag.public static int computeInt64Size(int fieldNumber, long value)
int64
field, including tag.public static int computeInt32Size(int fieldNumber, int value)
int32
field, including tag.public static int computeFixed64Size(int fieldNumber, long value)
fixed64
field, including tag.public static int computeFixed32Size(int fieldNumber, int value)
fixed32
field, including tag.public static int computeBoolSize(int fieldNumber, boolean value)
bool
field, including tag.public static int computeStringSize(int fieldNumber, java.lang.String value)
string
field, including tag.public static int computeGroupSize(int fieldNumber, MessageLite value)
group
field, including tag.@Deprecated public static int computeUnknownGroupSize(int fieldNumber, MessageLite value)
computeGroupSize(int, com.google.protobuf.MessageLite)
.group
field represented by an UnknownFieldSet
, including
tag.public static int computeMessageSize(int fieldNumber, MessageLite value)
public static int computeBytesSize(int fieldNumber, ByteString value)
bytes
field, including tag.public static int computeLazyFieldSize(int fieldNumber, com.google.protobuf.LazyField value)
public static int computeUInt32Size(int fieldNumber, int value)
uint32
field, including tag.public static int computeEnumSize(int fieldNumber, int value)
public static int computeSFixed32Size(int fieldNumber, int value)
sfixed32
field, including tag.public static int computeSFixed64Size(int fieldNumber, long value)
sfixed64
field, including tag.public static int computeSInt32Size(int fieldNumber, int value)
sint32
field, including tag.public static int computeSInt64Size(int fieldNumber, long value)
sint64
field, including tag.public static int computeMessageSetExtensionSize(int fieldNumber, MessageLite value)
public static int computeRawMessageSetExtensionSize(int fieldNumber, ByteString value)
public static int computeLazyFieldMessageSetExtensionSize(int fieldNumber, com.google.protobuf.LazyField value)
public static int computeDoubleSizeNoTag(double value)
double
field, including tag.public static int computeFloatSizeNoTag(float value)
float
field, including tag.public static int computeUInt64SizeNoTag(long value)
uint64
field, including tag.public static int computeInt64SizeNoTag(long value)
int64
field, including tag.public static int computeInt32SizeNoTag(int value)
int32
field, including tag.public static int computeFixed64SizeNoTag(long value)
fixed64
field.public static int computeFixed32SizeNoTag(int value)
fixed32
field.public static int computeBoolSizeNoTag(boolean value)
bool
field.public static int computeStringSizeNoTag(java.lang.String value)
string
field.public static int computeGroupSizeNoTag(MessageLite value)
group
field.@Deprecated public static int computeUnknownGroupSizeNoTag(MessageLite value)
computeUnknownGroupSizeNoTag(com.google.protobuf.MessageLite)
.group
field represented by an UnknownFieldSet
, including
tag.public static int computeMessageSizeNoTag(MessageLite value)
public static int computeLazyFieldSizeNoTag(com.google.protobuf.LazyField value)
public static int computeBytesSizeNoTag(ByteString value)
bytes
field.public static int computeUInt32SizeNoTag(int value)
uint32
field.public static int computeEnumSizeNoTag(int value)
public static int computeSFixed32SizeNoTag(int value)
sfixed32
field.public static int computeSFixed64SizeNoTag(long value)
sfixed64
field.public static int computeSInt32SizeNoTag(int value)
sint32
field.public static int computeSInt64SizeNoTag(long value)
sint64
field.public void flush() throws java.io.IOException
java.io.IOException
public int spaceLeft()
UnsupportedOperationException
.public void checkNoSpaceLeft()
spaceLeft()
returns zero. It's common to create
a byte array that is exactly big enough to hold a message, then write to
it with a CodedOutputStream
. Calling checkNoSpaceLeft()
after writing verifies that the message was actually as big as expected,
which can help catch bugs.public void writeRawByte(byte value) throws java.io.IOException
java.io.IOException
public void writeRawByte(int value) throws java.io.IOException
java.io.IOException
public void writeRawBytes(ByteString value) throws java.io.IOException
java.io.IOException
public void writeRawBytes(byte[] value) throws java.io.IOException
java.io.IOException
public void writeRawBytes(byte[] value, int offset, int length) throws java.io.IOException
java.io.IOException
public void writeRawBytes(ByteString value, int offset, int length) throws java.io.IOException
java.io.IOException
public void writeTag(int fieldNumber, int wireType) throws java.io.IOException
java.io.IOException
public static int computeTagSize(int fieldNumber)
public void writeRawVarint32(int value) throws java.io.IOException
value
is treated as
unsigned, so it won't be sign-extended if negative.java.io.IOException
public static int computeRawVarint32Size(int value)
value
is treated as unsigned, so it won't be sign-extended if
negative.public void writeRawVarint64(long value) throws java.io.IOException
java.io.IOException
public static int computeRawVarint64Size(long value)
public void writeRawLittleEndian32(int value) throws java.io.IOException
java.io.IOException
public void writeRawLittleEndian64(long value) throws java.io.IOException
java.io.IOException
public static int encodeZigZag32(int n)
n
- A signed 32-bit integer.public static long encodeZigZag64(long n)
n
- A signed 64-bit integer.