com.google.protobuf.CodedOutputStream Class Reference

Inheritance diagram for com.google.protobuf.CodedOutputStream:

Classes
class	AbstractBufferedEncoder
class	ArrayEncoder
class	ByteOutputEncoder
class	HeapNioEncoder
class	OutOfSpaceException
class	OutputStreamEncoder
class	SafeDirectNioEncoder
class	UnsafeDirectNioEncoder

Public Member Functions
final void	checkNoSpaceLeft ()
abstract void	flush () throws IOException
abstract int	getTotalBytesWritten ()
abstract int	spaceLeft ()
void	useDeterministicSerialization ()
abstract void	write (byte value) throws IOException
abstract void	write (byte[] value, int offset, int length) throws IOException
abstract void	write (ByteBuffer value) throws IOException
abstract void	writeBool (int fieldNumber, boolean value) throws IOException
final void	writeBoolNoTag (final boolean value) throws IOException
abstract void	writeByteArray (int fieldNumber, byte[] value) throws IOException
abstract void	writeByteArray (int fieldNumber, byte[] value, int offset, int length) throws IOException
final void	writeByteArrayNoTag (final byte[] value) throws IOException
abstract void	writeByteBuffer (int fieldNumber, ByteBuffer value) throws IOException
abstract void	writeBytes (int fieldNumber, ByteString value) throws IOException
abstract void	writeBytesNoTag (final ByteString value) throws IOException
final void	writeDouble (final int fieldNumber, final double value) throws IOException
final void	writeDoubleNoTag (final double value) throws IOException
final void	writeEnum (final int fieldNumber, final int value) throws IOException
final void	writeEnumNoTag (final int value) throws IOException
abstract void	writeFixed32 (int fieldNumber, int value) throws IOException
abstract void	writeFixed32NoTag (int value) throws IOException
abstract void	writeFixed64 (int fieldNumber, long value) throws IOException
abstract void	writeFixed64NoTag (long value) throws IOException
final void	writeFloat (final int fieldNumber, final float value) throws IOException
final void	writeFloatNoTag (final float value) throws IOException
final void	writeGroup (final int fieldNumber, final MessageLite value) throws IOException
final void	writeGroupNoTag (final MessageLite value) throws IOException
abstract void	writeInt32 (int fieldNumber, int value) throws IOException
abstract void	writeInt32NoTag (final int value) throws IOException
final void	writeInt64 (final int fieldNumber, final long value) throws IOException
final void	writeInt64NoTag (final long value) throws IOException
abstract void	writeLazy (byte[] value, int offset, int length) throws IOException
abstract void	writeLazy (ByteBuffer value) throws IOException
abstract void	writeMessage (final int fieldNumber, final MessageLite value) throws IOException
abstract void	writeMessageNoTag (final MessageLite value) throws IOException
abstract void	writeMessageSetExtension (final int fieldNumber, final MessageLite value) throws IOException
final void	writeRawByte (final byte value) throws IOException
final void	writeRawByte (final int value) throws IOException
final void	writeRawBytes (final byte[] value) throws IOException
final void	writeRawBytes (final byte[] value, int offset, int length) throws IOException
abstract void	writeRawBytes (final ByteBuffer value) throws IOException
final void	writeRawBytes (final ByteString value) throws IOException
final void	writeRawLittleEndian32 (final int value) throws IOException
final void	writeRawLittleEndian64 (final long value) throws IOException
abstract void	writeRawMessageSetExtension (final int fieldNumber, final ByteString value) throws IOException
final void	writeRawVarint32 (int value) throws IOException
final void	writeRawVarint64 (long value) throws IOException
final void	writeSFixed32 (final int fieldNumber, final int value) throws IOException
final void	writeSFixed32NoTag (final int value) throws IOException
final void	writeSFixed64 (final int fieldNumber, final long value) throws IOException
final void	writeSFixed64NoTag (final long value) throws IOException
final void	writeSInt32 (final int fieldNumber, final int value) throws IOException
final void	writeSInt32NoTag (final int value) throws IOException
final void	writeSInt64 (final int fieldNumber, final long value) throws IOException
final void	writeSInt64NoTag (final long value) throws IOException
abstract void	writeString (int fieldNumber, String value) throws IOException
abstract void	writeStringNoTag (String value) throws IOException
abstract void	writeTag (int fieldNumber, int wireType) throws IOException
abstract void	writeUInt32 (int fieldNumber, int value) throws IOException
abstract void	writeUInt32NoTag (int value) throws IOException
abstract void	writeUInt64 (int fieldNumber, long value) throws IOException
abstract void	writeUInt64NoTag (long value) throws IOException

Static Public Member Functions
static int	computeBoolSize (final int fieldNumber, final boolean value)
static int	computeBoolSizeNoTag (@SuppressWarnings("unused") final boolean unused)
static int	computeByteArraySize (final int fieldNumber, final byte[] value)
static int	computeByteArraySizeNoTag (final byte[] value)
static int	computeByteBufferSize (final int fieldNumber, final ByteBuffer value)
static int	computeByteBufferSizeNoTag (final ByteBuffer value)
static int	computeBytesSize (final int fieldNumber, final ByteString value)
static int	computeBytesSizeNoTag (final ByteString value)
static int	computeDoubleSize (final int fieldNumber, final double value)
static int	computeDoubleSizeNoTag (@SuppressWarnings("unused") final double unused)
static int	computeEnumSize (final int fieldNumber, final int value)
static int	computeEnumSizeNoTag (final int value)
static int	computeFixed32Size (final int fieldNumber, final int value)
static int	computeFixed32SizeNoTag (@SuppressWarnings("unused") final int unused)
static int	computeFixed64Size (final int fieldNumber, final long value)
static int	computeFixed64SizeNoTag (@SuppressWarnings("unused") final long unused)
static int	computeFloatSize (final int fieldNumber, final float value)
static int	computeFloatSizeNoTag (@SuppressWarnings("unused") final float unused)
static int	computeGroupSize (final int fieldNumber, final MessageLite value)
static int	computeGroupSizeNoTag (final MessageLite value)
static int	computeInt32Size (final int fieldNumber, final int value)
static int	computeInt32SizeNoTag (final int value)
static int	computeInt64Size (final int fieldNumber, final long value)
static int	computeInt64SizeNoTag (final long value)
static int	computeLazyFieldMessageSetExtensionSize (final int fieldNumber, final LazyFieldLite value)
static int	computeLazyFieldSize (final int fieldNumber, final LazyFieldLite value)
static int	computeLazyFieldSizeNoTag (final LazyFieldLite value)
static int	computeMessageSetExtensionSize (final int fieldNumber, final MessageLite value)
static int	computeMessageSize (final int fieldNumber, final MessageLite value)
static int	computeMessageSizeNoTag (final MessageLite value)
static int	computeRawMessageSetExtensionSize (final int fieldNumber, final ByteString value)
static int	computeRawVarint32Size (final int value)
static int	computeRawVarint64Size (long value)
static int	computeSFixed32Size (final int fieldNumber, final int value)
static int	computeSFixed32SizeNoTag (@SuppressWarnings("unused") final int unused)
static int	computeSFixed64Size (final int fieldNumber, final long value)
static int	computeSFixed64SizeNoTag (@SuppressWarnings("unused") final long unused)
static int	computeSInt32Size (final int fieldNumber, final int value)
static int	computeSInt32SizeNoTag (final int value)
static int	computeSInt64Size (final int fieldNumber, final long value)
static int	computeSInt64SizeNoTag (final long value)
static int	computeStringSize (final int fieldNumber, final String value)
static int	computeStringSizeNoTag (final String value)
static int	computeTagSize (final int fieldNumber)
static int	computeUInt32Size (final int fieldNumber, final int value)
static int	computeUInt32SizeNoTag (final int value)
static int	computeUInt64Size (final int fieldNumber, final long value)
static int	computeUInt64SizeNoTag (long value)
static int	encodeZigZag32 (final int n)
static long	encodeZigZag64 (final long n)
static CodedOutputStream	newInstance (ByteBuffer buffer)
static CodedOutputStream	newInstance (ByteBuffer byteBuffer, @SuppressWarnings("unused") int unused)
static CodedOutputStream	newInstance (final byte[] flatArray)
static CodedOutputStream	newInstance (final byte[] flatArray, final int offset, final int length)
static CodedOutputStream	newInstance (final OutputStream output)
static CodedOutputStream	newInstance (final OutputStream output, final int bufferSize)

Static Public Attributes
static final int	DEFAULT_BUFFER_SIZE = 4096
static final int	LITTLE_ENDIAN_32_SIZE = FIXED32_SIZE

Private Member Functions
	CodedOutputStream ()

Private Attributes
boolean	serializationDeterministic

Static Private Attributes
static final boolean	HAS_UNSAFE_ARRAY_OPERATIONS = UnsafeUtil.hasUnsafeArrayOperations()
static final Logger	logger = Logger.getLogger(CodedOutputStream.class.getName())

Detailed Description

Encodes and writes protocol message fields.

This class contains two kinds of methods: methods that write specific protocol message constructs and field types (e.g. writeTag and writeInt32) and methods that write low-level values (e.g. writeRawVarint32 and writeRawBytes). 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.

Definition at line 59 of file CodedOutputStream.java.

Constructor & Destructor Documentation

CodedOutputStream()

com.google.protobuf.CodedOutputStream.CodedOutputStream ( )

inlineprivate

Definition at line 224 of file CodedOutputStream.java.

Member Function Documentation

checkNoSpaceLeft()

final void com.google.protobuf.CodedOutputStream.checkNoSpaceLeft ( )

inline

Verifies that 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.

Definition at line 937 of file CodedOutputStream.java.

computeBoolSize()

static int com.google.protobuf.CodedOutputStream.computeBoolSize ( final int  fieldNumber, final boolean  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

bool 

field, including tag.

Definition at line 603 of file CodedOutputStream.java.

computeBoolSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeBoolSizeNoTag ( @SuppressWarnings("unused") final boolean  unused )

inlinestatic

Compute the number of bytes that would be needed to encode a

bool 

field.

Definition at line 826 of file CodedOutputStream.java.

computeByteArraySize()

static int com.google.protobuf.CodedOutputStream.computeByteArraySize ( final int  fieldNumber, final byte[]  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

bytes 

field, including tag.

Definition at line 636 of file CodedOutputStream.java.

computeByteArraySizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeByteArraySizeNoTag ( final byte[]  value )

inlinestatic

Compute the number of bytes that would be needed to encode a

bytes 

field.

Definition at line 866 of file CodedOutputStream.java.

computeByteBufferSize()

static int com.google.protobuf.CodedOutputStream.computeByteBufferSize ( final int  fieldNumber, final ByteBuffer  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

bytes 

field, including tag.

Definition at line 644 of file CodedOutputStream.java.

computeByteBufferSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeByteBufferSizeNoTag ( final ByteBuffer  value )

inlinestatic

Compute the number of bytes that would be needed to encode a

bytes 

field.

Definition at line 871 of file CodedOutputStream.java.

computeBytesSize()

static int com.google.protobuf.CodedOutputStream.computeBytesSize ( final int  fieldNumber, final ByteString  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

bytes 

field, including tag.

Definition at line 628 of file CodedOutputStream.java.

computeBytesSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeBytesSizeNoTag ( final ByteString  value )

inlinestatic

Compute the number of bytes that would be needed to encode a

bytes 

field.

Definition at line 861 of file CodedOutputStream.java.

computeDoubleSize()

static int com.google.protobuf.CodedOutputStream.computeDoubleSize ( final int  fieldNumber, final double  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

double 

field, including tag.

Definition at line 596 of file CodedOutputStream.java.

computeDoubleSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeDoubleSizeNoTag ( @SuppressWarnings("unused") final double  unused )

inlinestatic

Compute the number of bytes that would be needed to encode a

double 

field, including tag.

Definition at line 821 of file CodedOutputStream.java.

computeEnumSize()

static int com.google.protobuf.CodedOutputStream.computeEnumSize ( final int  fieldNumber, final int  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an enum field, including tag. The provided value is the numeric value used to represent the enum value on the wire (not the enum ordinal value).

Definition at line 612 of file CodedOutputStream.java.

computeEnumSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeEnumSizeNoTag ( final int  value )

inlinestatic

Compute the number of bytes that would be needed to encode an enum field. The provided value is the numeric value used to represent the enum value on the wire (not the enum ordinal value).

Definition at line 834 of file CodedOutputStream.java.

computeFixed32Size()

static int com.google.protobuf.CodedOutputStream.computeFixed32Size ( final int  fieldNumber, final int  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

fixed32 

field, including tag.

Definition at line 532 of file CodedOutputStream.java.

computeFixed32SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeFixed32SizeNoTag ( @SuppressWarnings("unused") final int  unused )

inlinestatic

Compute the number of bytes that would be needed to encode a

fixed32 

field.

Definition at line 749 of file CodedOutputStream.java.

computeFixed64Size()

static int com.google.protobuf.CodedOutputStream.computeFixed64Size ( final int  fieldNumber, final long  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

fixed64 

field, including tag.

Definition at line 572 of file CodedOutputStream.java.

computeFixed64SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeFixed64SizeNoTag ( @SuppressWarnings("unused") final long  unused )

inlinestatic

Compute the number of bytes that would be needed to encode a

fixed64 

field.

Definition at line 800 of file CodedOutputStream.java.

computeFloatSize()

static int com.google.protobuf.CodedOutputStream.computeFloatSize ( final int  fieldNumber, final float  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

float 

field, including tag.

Definition at line 588 of file CodedOutputStream.java.

computeFloatSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeFloatSizeNoTag ( @SuppressWarnings("unused") final float  unused )

inlinestatic

Compute the number of bytes that would be needed to encode a

float 

field, including tag.

Definition at line 813 of file CodedOutputStream.java.

computeGroupSize()

static int com.google.protobuf.CodedOutputStream.computeGroupSize ( final int  fieldNumber, final MessageLite  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

group 

field, including tag.

Deprecated:

groups are deprecated.

Definition at line 1058 of file CodedOutputStream.java.

computeGroupSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeGroupSizeNoTag ( final MessageLite  value )

inlinestatic

Compute the number of bytes that would be needed to encode a

group 

field.

Definition at line 1075 of file CodedOutputStream.java.

computeInt32Size()

static int com.google.protobuf.CodedOutputStream.computeInt32Size ( final int  fieldNumber, final int  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an

int32 

field, including tag.

Definition at line 508 of file CodedOutputStream.java.

computeInt32SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeInt32SizeNoTag ( final int  value )

inlinestatic

Compute the number of bytes that would be needed to encode an

int32 

field, including tag.

Definition at line 717 of file CodedOutputStream.java.

computeInt64Size()

static int com.google.protobuf.CodedOutputStream.computeInt64Size ( final int  fieldNumber, final long  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an

int64 

field, including tag.

Definition at line 548 of file CodedOutputStream.java.

computeInt64SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeInt64SizeNoTag ( final long  value )

inlinestatic

Compute the number of bytes that would be needed to encode an

int64 

field, including tag.

Definition at line 762 of file CodedOutputStream.java.

computeLazyFieldMessageSetExtensionSize()

static int com.google.protobuf.CodedOutputStream.computeLazyFieldMessageSetExtensionSize ( final int  fieldNumber, final LazyFieldLite  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an lazily parsed MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.

Definition at line 699 of file CodedOutputStream.java.

computeLazyFieldSize()

static int com.google.protobuf.CodedOutputStream.computeLazyFieldSize ( final int  fieldNumber, final LazyFieldLite  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an embedded message in lazy field, including tag.

Definition at line 652 of file CodedOutputStream.java.

computeLazyFieldSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeLazyFieldSizeNoTag ( final LazyFieldLite  value )

inlinestatic

Compute the number of bytes that would be needed to encode an embedded message stored in lazy field.

Definition at line 856 of file CodedOutputStream.java.

computeMessageSetExtensionSize()

static int com.google.protobuf.CodedOutputStream.computeMessageSetExtensionSize ( final int  fieldNumber, final MessageLite  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a MessageSet extension to the stream. For historical reasons, the wire format differs from normal fields.

Definition at line 677 of file CodedOutputStream.java.

computeMessageSize()

static int com.google.protobuf.CodedOutputStream.computeMessageSize ( final int  fieldNumber, final MessageLite  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an embedded message field, including tag.

Definition at line 660 of file CodedOutputStream.java.

computeMessageSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeMessageSizeNoTag ( final MessageLite  value )

inlinestatic

Compute the number of bytes that would be needed to encode an embedded message field.

Definition at line 876 of file CodedOutputStream.java.

computeRawMessageSetExtensionSize()

static int com.google.protobuf.CodedOutputStream.computeRawMessageSetExtensionSize ( final int  fieldNumber, final ByteString  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an unparsed MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.

Definition at line 687 of file CodedOutputStream.java.

computeRawVarint32Size()

static int com.google.protobuf.CodedOutputStream.computeRawVarint32Size ( final int  value )

inlinestatic

Compute the number of bytes that would be needed to encode a varint.

value 

is treated as unsigned, so it won't be sign-extended if negative.

Deprecated:

use computeUInt32SizeNoTag(int) instead.

Definition at line 1113 of file CodedOutputStream.java.

computeRawVarint64Size()

static int com.google.protobuf.CodedOutputStream.computeRawVarint64Size ( long  value )

inlinestatic

Compute the number of bytes that would be needed to encode a varint.

Deprecated:

use computeUInt64SizeNoTag(long) instead.

Definition at line 1123 of file CodedOutputStream.java.

computeSFixed32Size()

static int com.google.protobuf.CodedOutputStream.computeSFixed32Size ( final int  fieldNumber, final int  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an

sfixed32 

field, including tag.

Definition at line 540 of file CodedOutputStream.java.

computeSFixed32SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeSFixed32SizeNoTag ( @SuppressWarnings("unused") final int  unused )

inlinestatic

Compute the number of bytes that would be needed to encode an

sfixed32 

field.

Definition at line 754 of file CodedOutputStream.java.

computeSFixed64Size()

static int com.google.protobuf.CodedOutputStream.computeSFixed64Size ( final int  fieldNumber, final long  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an

sfixed64 

field, including tag.

Definition at line 580 of file CodedOutputStream.java.

computeSFixed64SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeSFixed64SizeNoTag ( @SuppressWarnings("unused") final long  unused )

inlinestatic

Compute the number of bytes that would be needed to encode an

sfixed64 

field.

Definition at line 805 of file CodedOutputStream.java.

computeSInt32Size()

static int com.google.protobuf.CodedOutputStream.computeSInt32Size ( final int  fieldNumber, final int  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an

sint32 

field, including tag.

Definition at line 524 of file CodedOutputStream.java.

computeSInt32SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeSInt32SizeNoTag ( final int  value )

inlinestatic

Compute the number of bytes that would be needed to encode an

sint32 

field.

Definition at line 744 of file CodedOutputStream.java.

computeSInt64Size()

static int com.google.protobuf.CodedOutputStream.computeSInt64Size ( final int  fieldNumber, final long  value  )

inlinestatic

Compute the number of bytes that would be needed to encode an

sint64 

field, including tag.

Definition at line 564 of file CodedOutputStream.java.

computeSInt64SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeSInt64SizeNoTag ( final long  value )

inlinestatic

Compute the number of bytes that would be needed to encode an

sint64 

field.

Definition at line 795 of file CodedOutputStream.java.

computeStringSize()

static int com.google.protobuf.CodedOutputStream.computeStringSize ( final int  fieldNumber, final String  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

string 

field, including tag.

Definition at line 620 of file CodedOutputStream.java.

computeStringSizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeStringSizeNoTag ( final String  value )

inlinestatic

Compute the number of bytes that would be needed to encode a

string 

field.

Definition at line 839 of file CodedOutputStream.java.

computeTagSize()

static int com.google.protobuf.CodedOutputStream.computeTagSize ( final int  fieldNumber )

inlinestatic

Compute the number of bytes that would be needed to encode a tag.

Definition at line 709 of file CodedOutputStream.java.

computeUInt32Size()

static int com.google.protobuf.CodedOutputStream.computeUInt32Size ( final int  fieldNumber, final int  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

uint32 

field, including tag.

Definition at line 516 of file CodedOutputStream.java.

computeUInt32SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag ( final int  value )

inlinestatic

Compute the number of bytes that would be needed to encode a

uint32 

field.

Definition at line 727 of file CodedOutputStream.java.

computeUInt64Size()

static int com.google.protobuf.CodedOutputStream.computeUInt64Size ( final int  fieldNumber, final long  value  )

inlinestatic

Compute the number of bytes that would be needed to encode a

uint64 

field, including tag.

Definition at line 556 of file CodedOutputStream.java.

computeUInt64SizeNoTag()

static int com.google.protobuf.CodedOutputStream.computeUInt64SizeNoTag ( long  value )

inlinestatic

Compute the number of bytes that would be needed to encode a

uint64 

field, including tag.

Definition at line 770 of file CodedOutputStream.java.

encodeZigZag32()

static int com.google.protobuf.CodedOutputStream.encodeZigZag32 ( final int  n )

inlinestatic

Encode 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	A signed 32-bit integer.

Returns

An unsigned 32-bit integer, stored in a signed int because Java has no explicit unsigned support.

Definition at line 898 of file CodedOutputStream.java.

encodeZigZag64()

static long com.google.protobuf.CodedOutputStream.encodeZigZag64 ( final long  n )

inlinestatic

Encode 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	A signed 64-bit integer.

Returns

An unsigned 64-bit integer, stored in a signed int because Java has no explicit unsigned support.

Definition at line 912 of file CodedOutputStream.java.

flush()

abstract void com.google.protobuf.CodedOutputStream.flush ( ) throws IOException

abstract

Flushes the stream and forces any buffered bytes to be written. This does not flush the underlying OutputStream.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.HeapNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

getTotalBytesWritten()

abstract int com.google.protobuf.CodedOutputStream.getTotalBytesWritten ( )

abstract

Get the total number of bytes successfully written to this stream. The returned value is not guaranteed to be accurate if exceptions have been found in the middle of writing.

Reimplemented in com.google.protobuf.CodedOutputStream.AbstractBufferedEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

newInstance() [1/6]

static CodedOutputStream com.google.protobuf.CodedOutputStream.newInstance ( ByteBuffer  buffer )

inlinestatic

Create a new

CodedOutputStream 

that writes to the given ByteBuffer.

Definition at line 130 of file CodedOutputStream.java.

newInstance() [2/6]

static CodedOutputStream com.google.protobuf.CodedOutputStream.newInstance ( ByteBuffer  byteBuffer, @SuppressWarnings("unused") int  unused  )

inlinestatic

Create a new

CodedOutputStream 

that writes to the given ByteBuffer.

Deprecated:

the size parameter is no longer used since use of an internal buffer is useless (and wasteful) when writing to a ByteBuffer. Use newInstance(ByteBuffer) instead.

Definition at line 199 of file CodedOutputStream.java.

newInstance() [3/6]

static CodedOutputStream com.google.protobuf.CodedOutputStream.newInstance ( final byte[]  flatArray )

inlinestatic

Create a new

CodedOutputStream 

that writes directly to the given byte array. If more bytes are written than fit in the array, OutOfSpaceException will be thrown. Writing directly to a flat array is faster than writing to an

OutputStream 

. See also {}.

Definition at line 114 of file CodedOutputStream.java.

newInstance() [4/6]

static CodedOutputStream com.google.protobuf.CodedOutputStream.newInstance ( final byte[]  flatArray, final int  offset, final int  length  )

inlinestatic

Create a new

CodedOutputStream 

that writes directly to the given byte array slice. If more bytes are written than fit in the slice, OutOfSpaceException will be thrown. Writing directly to a flat array is faster than writing to an

OutputStream 

. See also ByteString#newCodedBuilder.

Definition at line 124 of file CodedOutputStream.java.

newInstance() [5/6]

static CodedOutputStream com.google.protobuf.CodedOutputStream.newInstance ( final OutputStream  output )

inlinestatic

Create a new

CodedOutputStream 

wrapping the given

OutputStream 

.

NOTE: The provided OutputStream MUST NOT retain access or modify the provided byte arrays. Doing so may result in corrupted data, which would be difficult to debug.

Definition at line 92 of file CodedOutputStream.java.

newInstance() [6/6]

static CodedOutputStream com.google.protobuf.CodedOutputStream.newInstance ( final OutputStream  output, final int  bufferSize  )

inlinestatic

Create a new

CodedOutputStream 

wrapping the given

OutputStream 

with a given buffer size.

NOTE: The provided OutputStream MUST NOT retain access or modify the provided byte arrays. Doing so may result in corrupted data, which would be difficult to debug.

Definition at line 104 of file CodedOutputStream.java.

spaceLeft()

abstract int com.google.protobuf.CodedOutputStream.spaceLeft ( )

abstract

If writing to a flat array, return the space left in the array. Otherwise, throws

UnsupportedOperationException 

.

Reimplemented in com.google.protobuf.CodedOutputStream.AbstractBufferedEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

useDeterministicSerialization()

void com.google.protobuf.CodedOutputStream.useDeterministicSerialization ( )

inline

Configures serialization to be deterministic.

The deterministic serialization guarantees that for a given binary, equal (defined by the

equals() 

methods in protos) messages will always be serialized to the same bytes. This implies:

• repeated serialization of a message will return the same bytes
• different processes of the same binary (which may be executing on different machines) will serialize equal messages to the same bytes.

Note the deterministic serialization is NOT canonical across languages; it is also unstable across different builds with schema changes due to unknown fields. Users who need canonical serialization, e.g. persistent storage in a canonical form, fingerprinting, etc, should define their own canonicalization specification and implement the serializer using reflection APIs rather than relying on this API.

Once set, the serializer will: (Note this is an implementation detail and may subject to change in the future)

• sort map entries by keys in lexicographical order or numerical order. Note: For string keys, the order is based on comparing the Unicode value of each character in the strings. The order may be different from the deterministic serialization in other languages where maps are sorted on the lexicographical order of the UTF8 encoded keys.

Definition at line 181 of file CodedOutputStream.java.

write() [1/3]

abstract void com.google.protobuf.CodedOutputStream.write ( byte  value ) throws IOException

abstract

Writes a single byte.

Parameters

value

the byte to be written

Exceptions

IOException

thrown if an error occurred while writing

Reimplemented from com.google.protobuf.ByteOutput.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

write() [2/3]

abstract void com.google.protobuf.CodedOutputStream.write ( byte[]  value, int  offset, int  length  ) throws IOException

abstract

Writes a sequence of bytes. The ByteOutput must copy

value 

if it will not be processed prior to the return of this method call, since

value 

may be reused/altered by the caller.

NOTE: This method MUST NOT modify the

value 

. Doing so is a programming error and will lead to data corruption which will be difficult to debug.

Parameters

value	the bytes to be written
offset	the offset of the start of the writable range
length	the number of bytes to write starting from offset

Exceptions

IOException

thrown if an error occurred while writing

Reimplemented from com.google.protobuf.ByteOutput.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

write() [3/3]

abstract void com.google.protobuf.CodedOutputStream.write ( ByteBuffer  value ) throws IOException

abstract

Writes a sequence of bytes. The ByteOutput must copy

value 

if it will not be processed prior to the return of this method call, since

value 

may be reused/altered by the caller.

NOTE: This method MUST NOT modify the

value 

. Doing so is a programming error and will lead to data corruption which will be difficult to debug.

Parameters

value

the bytes to be written. Upon returning from this call, the position of this buffer will be set to the limit

Exceptions

IOException

thrown if an error occurred while writing

Reimplemented from com.google.protobuf.ByteOutput.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeBool()

abstract void com.google.protobuf.CodedOutputStream.writeBool ( int  fieldNumber, boolean  value  ) throws IOException

abstract

Write a

bool 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeBoolNoTag()

final void com.google.protobuf.CodedOutputStream.writeBoolNoTag ( final boolean  value ) throws IOException

inline

Write a

bool 

field to the stream.

Definition at line 446 of file CodedOutputStream.java.

writeByteArray() [1/2]

abstract void com.google.protobuf.CodedOutputStream.writeByteArray ( int  fieldNumber, byte[]  value  ) throws IOException

abstract

Write a

bytes 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeByteArray() [2/2]

abstract void com.google.protobuf.CodedOutputStream.writeByteArray ( int  fieldNumber, byte[]  value, int  offset, int  length  ) throws IOException

abstract

Write a

bytes 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeByteArrayNoTag()

final void com.google.protobuf.CodedOutputStream.writeByteArrayNoTag ( final byte[]  value ) throws IOException

inline

Write a

bytes 

field to the stream.

Definition at line 468 of file CodedOutputStream.java.

writeByteBuffer()

abstract void com.google.protobuf.CodedOutputStream.writeByteBuffer ( int  fieldNumber, ByteBuffer  value  ) throws IOException

abstract

Write a

bytes 

field, including tag, to the stream. This method will write all content of the ByteBuffer regardless of the current position and limit (i.e., the number of bytes to be written is value.capacity(), not value.remaining()). Furthermore, this method doesn't alter the state of the passed-in ByteBuffer. Its position, limit, mark, etc. will remain unchanged. If you only want to write the remaining bytes of a ByteBuffer, you can call

writeByteBuffer(fieldNumber, byteBuffer.slice()) 

.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeBytes()

abstract void com.google.protobuf.CodedOutputStream.writeBytes ( int  fieldNumber, ByteString  value  ) throws IOException

abstract

Write a

bytes 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeBytesNoTag()

abstract void com.google.protobuf.CodedOutputStream.writeBytesNoTag ( final ByteString  value ) throws IOException

abstract

Write a

bytes 

field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.ArrayEncoder, and com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder.

writeDouble()

final void com.google.protobuf.CodedOutputStream.writeDouble ( final int  fieldNumber, final double  value  ) throws IOException

inline

Write a

double 

field, including tag, to the stream.

Definition at line 283 of file CodedOutputStream.java.

writeDoubleNoTag()

final void com.google.protobuf.CodedOutputStream.writeDoubleNoTag ( final double  value ) throws IOException

inline

Write a

double 

field to the stream.

Definition at line 441 of file CodedOutputStream.java.

writeEnum()

final void com.google.protobuf.CodedOutputStream.writeEnum ( final int  fieldNumber, final int  value  ) throws IOException

inline

Write an enum field, including tag, to the stream. The provided value is the numeric value used to represent the enum value on the wire (not the enum ordinal value).

Definition at line 295 of file CodedOutputStream.java.

writeEnumNoTag()

final void com.google.protobuf.CodedOutputStream.writeEnumNoTag ( final int  value ) throws IOException

inline

Write an enum field to the stream. The provided value is the numeric value used to represent the enum value on the wire (not the enum ordinal value).

Definition at line 454 of file CodedOutputStream.java.

writeFixed32()

abstract void com.google.protobuf.CodedOutputStream.writeFixed32 ( int  fieldNumber, int  value  ) throws IOException

abstract

Write a

fixed32 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeFixed32NoTag()

abstract void com.google.protobuf.CodedOutputStream.writeFixed32NoTag ( int  value ) throws IOException

abstract

Write a

fixed32 

field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.ArrayEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, and com.google.protobuf.CodedOutputStream.ByteOutputEncoder.

writeFixed64()

abstract void com.google.protobuf.CodedOutputStream.writeFixed64 ( int  fieldNumber, long  value  ) throws IOException

abstract

Write a

fixed64 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeFixed64NoTag()

abstract void com.google.protobuf.CodedOutputStream.writeFixed64NoTag ( long  value ) throws IOException

abstract

Write a

fixed64 

field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.ArrayEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, and com.google.protobuf.CodedOutputStream.ByteOutputEncoder.

writeFloat()

final void com.google.protobuf.CodedOutputStream.writeFloat ( final int  fieldNumber, final float  value  ) throws IOException

inline

Write a

float 

field, including tag, to the stream.

Definition at line 278 of file CodedOutputStream.java.

writeFloatNoTag()

final void com.google.protobuf.CodedOutputStream.writeFloatNoTag ( final float  value ) throws IOException

inline

Write a

float 

field to the stream.

Definition at line 436 of file CodedOutputStream.java.

writeGroup()

final void com.google.protobuf.CodedOutputStream.writeGroup ( final int  fieldNumber, final MessageLite  value  ) throws IOException

inline

Write a

group 

field, including tag, to the stream.

Deprecated:

groups are deprecated.

Definition at line 1012 of file CodedOutputStream.java.

writeGroupNoTag()

final void com.google.protobuf.CodedOutputStream.writeGroupNoTag ( final MessageLite  value ) throws IOException

inline

Write a

group 

field to the stream.

Deprecated:

groups are deprecated.

Definition at line 1037 of file CodedOutputStream.java.

writeInt32()

abstract void com.google.protobuf.CodedOutputStream.writeInt32 ( int  fieldNumber, int  value  ) throws IOException

abstract

Write an

int32 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeInt32NoTag()

abstract void com.google.protobuf.CodedOutputStream.writeInt32NoTag ( final int  value ) throws IOException

abstract

Write an

int32 

field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeInt64()

final void com.google.protobuf.CodedOutputStream.writeInt64 ( final int  fieldNumber, final long  value  ) throws IOException

inline

Write an

int64 

field, including tag, to the stream.

Definition at line 255 of file CodedOutputStream.java.

writeInt64NoTag()

final void com.google.protobuf.CodedOutputStream.writeInt64NoTag ( final long  value ) throws IOException

inline

Write an

int64 

field to the stream.

Definition at line 413 of file CodedOutputStream.java.

writeLazy() [1/2]

abstract void com.google.protobuf.CodedOutputStream.writeLazy ( byte[]  value, int  offset, int  length  ) throws IOException

abstract

Writes a sequence of bytes. The ByteOutput is free to retain a reference to the value beyond the scope of this method call (e.g. write later) since it is considered immutable and is guaranteed not to change by the caller.

NOTE: This method MUST NOT modify the

value 

. Doing so is a programming error and will lead to data corruption which will be difficult to debug.

Parameters

value	the bytes to be written
offset	the offset of the start of the writable range
length	the number of bytes to write starting from offset

Exceptions

IOException

thrown if an error occurred while writing

Reimplemented from com.google.protobuf.ByteOutput.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeLazy() [2/2]

abstract void com.google.protobuf.CodedOutputStream.writeLazy ( ByteBuffer  value ) throws IOException

abstract

Writes a sequence of bytes. The ByteOutput is free to retain a reference to the value beyond the scope of this method call (e.g. write later) since it is considered immutable and is guaranteed not to change by the caller.

NOTE: This method MUST NOT modify the

value 

. Doing so is a programming error and will lead to data corruption which will be difficult to debug.

Parameters

value

the bytes to be written. Upon returning from this call, the position of this buffer will be set to the limit

Exceptions

IOException

thrown if an error occurred while writing

Reimplemented from com.google.protobuf.ByteOutput.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeMessage()

abstract void com.google.protobuf.CodedOutputStream.writeMessage ( final int  fieldNumber, final MessageLite  value  ) throws IOException

abstract

Write an embedded message field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeMessageNoTag()

abstract void com.google.protobuf.CodedOutputStream.writeMessageNoTag ( final MessageLite  value ) throws IOException

abstract

Write an embedded message field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeMessageSetExtension()

abstract void com.google.protobuf.CodedOutputStream.writeMessageSetExtension ( final int  fieldNumber, final MessageLite  value  ) throws IOException

abstract

Write a MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeRawByte() [1/2]

final void com.google.protobuf.CodedOutputStream.writeRawByte ( final byte  value ) throws IOException

inline

Write a single byte.

Definition at line 328 of file CodedOutputStream.java.

writeRawByte() [2/2]

final void com.google.protobuf.CodedOutputStream.writeRawByte ( final int  value ) throws IOException

inline

Write a single byte, represented by an integer value.

Definition at line 333 of file CodedOutputStream.java.

writeRawBytes() [1/4]

final void com.google.protobuf.CodedOutputStream.writeRawBytes ( final byte[]  value ) throws IOException

inline

Write an array of bytes.

Definition at line 338 of file CodedOutputStream.java.

writeRawBytes() [2/4]

final void com.google.protobuf.CodedOutputStream.writeRawBytes ( final byte[]  value, int  offset, int  length  ) throws IOException

inline

Write part of an array of bytes.

Definition at line 343 of file CodedOutputStream.java.

writeRawBytes() [3/4]

abstract void com.google.protobuf.CodedOutputStream.writeRawBytes ( final ByteBuffer  value ) throws IOException

abstract

Write a ByteBuffer. This method will write all content of the ByteBuffer regardless of the current position and limit (i.e., the number of bytes to be written is value.capacity(), not value.remaining()). Furthermore, this method doesn't alter the state of the passed-in ByteBuffer. Its position, limit, mark, etc. will remain unchanged. If you only want to write the remaining bytes of a ByteBuffer, you can call

writeRawBytes(byteBuffer.slice()) 

.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.ArrayEncoder, and com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder.

writeRawBytes() [4/4]

final void com.google.protobuf.CodedOutputStream.writeRawBytes ( final ByteString  value ) throws IOException

inline

Write a byte string.

Definition at line 348 of file CodedOutputStream.java.

writeRawLittleEndian32()

final void com.google.protobuf.CodedOutputStream.writeRawLittleEndian32 ( final int  value ) throws IOException

inline

Write a little-endian 32-bit integer.

Deprecated:

Use writeFixed32NoTag instead.

Definition at line 1133 of file CodedOutputStream.java.

writeRawLittleEndian64()

final void com.google.protobuf.CodedOutputStream.writeRawLittleEndian64 ( final long  value ) throws IOException

inline

Write a little-endian 64-bit integer.

Deprecated:

Use writeFixed64NoTag instead.

Definition at line 1143 of file CodedOutputStream.java.

writeRawMessageSetExtension()

abstract void com.google.protobuf.CodedOutputStream.writeRawMessageSetExtension ( final int  fieldNumber, final ByteString  value  ) throws IOException

abstract

Write an unparsed MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeRawVarint32()

final void com.google.protobuf.CodedOutputStream.writeRawVarint32 ( int  value ) throws IOException

inline

Encode and write a varint.

value 

is treated as unsigned, so it won't be sign-extended if negative.

Deprecated:

use writeUInt32NoTag instead.

Definition at line 1092 of file CodedOutputStream.java.

writeRawVarint64()

final void com.google.protobuf.CodedOutputStream.writeRawVarint64 ( long  value ) throws IOException

inline

Encode and write a varint.

Deprecated:

use writeUInt64NoTag instead.

Definition at line 1102 of file CodedOutputStream.java.

writeSFixed32()

final void com.google.protobuf.CodedOutputStream.writeSFixed32 ( final int  fieldNumber, final int  value  ) throws IOException

inline

Write an

sfixed32 

field, including tag, to the stream.

Definition at line 250 of file CodedOutputStream.java.

writeSFixed32NoTag()

final void com.google.protobuf.CodedOutputStream.writeSFixed32NoTag ( final int  value ) throws IOException

inline

Write a

sfixed32 

field to the stream.

Definition at line 408 of file CodedOutputStream.java.

writeSFixed64()

final void com.google.protobuf.CodedOutputStream.writeSFixed64 ( final int  fieldNumber, final long  value  ) throws IOException

inline

Write an

sfixed64 

field, including tag, to the stream.

Definition at line 273 of file CodedOutputStream.java.

writeSFixed64NoTag()

final void com.google.protobuf.CodedOutputStream.writeSFixed64NoTag ( final long  value ) throws IOException

inline

Write a

sfixed64 

field to the stream.

Definition at line 431 of file CodedOutputStream.java.

writeSInt32()

final void com.google.protobuf.CodedOutputStream.writeSInt32 ( final int  fieldNumber, final int  value  ) throws IOException

inline

Write a

sint32 

field, including tag, to the stream.

Definition at line 241 of file CodedOutputStream.java.

writeSInt32NoTag()

final void com.google.protobuf.CodedOutputStream.writeSInt32NoTag ( final int  value ) throws IOException

inline

Write a

sint32 

field to the stream.

Definition at line 399 of file CodedOutputStream.java.

writeSInt64()

final void com.google.protobuf.CodedOutputStream.writeSInt64 ( final int  fieldNumber, final long  value  ) throws IOException

inline

Write an

sint64 

field, including tag, to the stream.

Definition at line 264 of file CodedOutputStream.java.

writeSInt64NoTag()

final void com.google.protobuf.CodedOutputStream.writeSInt64NoTag ( final long  value ) throws IOException

inline

Write a

sint64 

field to the stream.

Definition at line 422 of file CodedOutputStream.java.

writeString()

abstract void com.google.protobuf.CodedOutputStream.writeString ( int  fieldNumber, String  value  ) throws IOException

abstract

Write a

string 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeStringNoTag()

abstract void com.google.protobuf.CodedOutputStream.writeStringNoTag ( String  value ) throws IOException

abstract

Write a

string 

field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeTag()

abstract void com.google.protobuf.CodedOutputStream.writeTag ( int  fieldNumber, int  wireType  ) throws IOException

abstract

Encode and write a tag.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeUInt32()

abstract void com.google.protobuf.CodedOutputStream.writeUInt32 ( int  fieldNumber, int  value  ) throws IOException

abstract

Write a

uint32 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeUInt32NoTag()

abstract void com.google.protobuf.CodedOutputStream.writeUInt32NoTag ( int  value ) throws IOException

abstract

Write a

uint32 

field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeUInt64()

abstract void com.google.protobuf.CodedOutputStream.writeUInt64 ( int  fieldNumber, long  value  ) throws IOException

abstract

Write a

uint64 

field, including tag, to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

writeUInt64NoTag()

abstract void com.google.protobuf.CodedOutputStream.writeUInt64NoTag ( long  value ) throws IOException

abstract

Write a

uint64 

field to the stream.

Reimplemented in com.google.protobuf.CodedOutputStream.OutputStreamEncoder, com.google.protobuf.CodedOutputStream.ByteOutputEncoder, com.google.protobuf.CodedOutputStream.UnsafeDirectNioEncoder, com.google.protobuf.CodedOutputStream.SafeDirectNioEncoder, and com.google.protobuf.CodedOutputStream.ArrayEncoder.

Member Data Documentation

DEFAULT_BUFFER_SIZE

final int com.google.protobuf.CodedOutputStream.DEFAULT_BUFFER_SIZE = 4096

static

The buffer size used in newInstance(OutputStream).

Definition at line 70 of file CodedOutputStream.java.

HAS_UNSAFE_ARRAY_OPERATIONS

final boolean com.google.protobuf.CodedOutputStream.HAS_UNSAFE_ARRAY_OPERATIONS = UnsafeUtil.hasUnsafeArrayOperations()

staticprivate

Definition at line 61 of file CodedOutputStream.java.

LITTLE_ENDIAN_32_SIZE

final int com.google.protobuf.CodedOutputStream.LITTLE_ENDIAN_32_SIZE = FIXED32_SIZE

static

Deprecated:

Use computeFixed32SizeNoTag(int) instead.

Definition at line 67 of file CodedOutputStream.java.

logger

final Logger com.google.protobuf.CodedOutputStream.logger = Logger.getLogger(CodedOutputStream.class.getName())

staticprivate

Definition at line 60 of file CodedOutputStream.java.

serializationDeterministic

boolean com.google.protobuf.CodedOutputStream.serializationDeterministic

private

Definition at line 189 of file CodedOutputStream.java.

---

The documentation for this class was generated from the following file:

• CodedOutputStream.java