Package com.google.protobuf

Class CodedOutputStream

java.lang.Object
com.google.protobuf.ByteOutput
com.google.protobuf.CodedOutputStream
public abstract class CodedOutputStream extends ByteOutput
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(int, int) and writeInt32(int, int)) and methods that write low-level values (e.g. writeRawVarint32(int) and writeRawBytes(byte[])). 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.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_BUFFER_SIZE
    The buffer size used in newInstance(OutputStream).
    static final int
    LITTLE_ENDIAN_32_SIZE
    Deprecated.
    Use computeFixed32SizeNoTag(int) instead.

  • Method Summary

    Modifier and Type
    Method
    Description
    final 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 unused)
    Compute the number of bytes that would be needed to encode a bool field.
    static int
    computeByteArraySize(int fieldNumber, byte[] value)
    Compute the number of bytes that would be needed to encode a bytes field, including tag.
    static int
    computeByteArraySizeNoTag(byte[] value)
    Compute the number of bytes that would be needed to encode a bytes field.
    static int
    computeByteBufferSize(int fieldNumber, ByteBuffer value)
    Compute the number of bytes that would be needed to encode a bytes field, including tag.
    static int
    computeByteBufferSizeNoTag(ByteBuffer value)
    Compute the number of bytes that would be needed to encode a bytes 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 unused)
    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 unused)
    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 unused)
    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 unused)
    Compute the number of bytes that would be needed to encode a float field, including tag.
    static int
    computeGroupSize(int fieldNumber, MessageLite value)
    Deprecated.
    groups are deprecated.
    static int
    computeGroupSizeNoTag(MessageLite value)
    Deprecated.
    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, excluding 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, LazyFieldLite value)
    Compute the number of bytes that would be needed to encode a lazily parsed MessageSet extension field to the stream.
    static int
    computeLazyFieldSize(int fieldNumber, LazyFieldLite value)
    Compute the number of bytes that would be needed to encode an embedded message in lazy field, including tag.
    static int
    computeLazyFieldSizeNoTag(LazyFieldLite 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)
    Deprecated.
    use computeUInt32SizeNoTag(int) instead.
    static int
    computeRawVarint64Size(long value)
    Deprecated.
    use computeUInt64SizeNoTag(long) instead.
    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 unused)
    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 unused)
    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, String value)
    Compute the number of bytes that would be needed to encode a string field, including tag.
    static int
    computeStringSizeNoTag(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
    encodeZigZag32(int n)
    Encode a ZigZag-encoded 32-bit value.
    static long
    encodeZigZag64(long n)
    Encode a ZigZag-encoded 64-bit value.
    abstract void
    flush()
    Flushes the stream and forces any buffered bytes to be written.
    abstract int
    getTotalBytesWritten()
    Get the total number of bytes successfully written to this stream.
    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(OutputStream output)
    Create a new CodedOutputStream wrapping the given OutputStream.
    static CodedOutputStream
    newInstance(OutputStream output, int bufferSize)
    Create a new CodedOutputStream wrapping the given OutputStream with a given buffer size.
    static CodedOutputStream
    newInstance(ByteBuffer buffer)
    Create a new CodedOutputStream that writes to the given ByteBuffer.
    static CodedOutputStream
    newInstance(ByteBuffer byteBuffer, int unused)
    Deprecated.
    the size parameter is no longer used since use of an internal buffer is useless (and wasteful) when writing to a ByteBuffer.
    abstract int
    spaceLeft()
    If writing to a flat array, return the space left in the array.
    void
    useDeterministicSerialization()
    Configures serialization to be deterministic.
    abstract void
    write(byte value)
    Writes a single byte.
    abstract void
    write(byte[] value, int offset, int length)
    Writes a sequence of bytes.
    abstract void
    write(ByteBuffer value)
    Writes a sequence of bytes.
    abstract void
    writeBool(int fieldNumber, boolean value)
    Write a bool field, including tag, to the stream.
    final void
    writeBoolNoTag(boolean value)
    Write a bool field to the stream.
    abstract void
    writeByteArray(int fieldNumber, byte[] value)
    Write a bytes field, including tag, to the stream.
    abstract void
    writeByteArray(int fieldNumber, byte[] value, int offset, int length)
    Write a bytes field, including tag, to the stream.
    final void
    writeByteArrayNoTag(byte[] value)
    Write a bytes field to the stream.
    abstract void
    writeByteBuffer(int fieldNumber, ByteBuffer value)
    Write a bytes field, including tag, to the stream.
    abstract void
    writeBytes(int fieldNumber, ByteString value)
    Write a bytes field, including tag, to the stream.
    abstract void
    writeBytesNoTag(ByteString value)
    Write a bytes field to the stream.
    final void
    writeDouble(int fieldNumber, double value)
    Write a double field, including tag, to the stream.
    final void
    writeDoubleNoTag(double value)
    Write a double field to the stream.
    final void
    writeEnum(int fieldNumber, int value)
    Write an enum field, including tag, to the stream.
    final void
    writeEnumNoTag(int value)
    Write an enum field to the stream.
    abstract void
    writeFixed32(int fieldNumber, int value)
    Write a fixed32 field, including tag, to the stream.
    abstract void
    writeFixed32NoTag(int value)
    Write a fixed32 field to the stream.
    abstract void
    writeFixed64(int fieldNumber, long value)
    Write a fixed64 field, including tag, to the stream.
    abstract void
    writeFixed64NoTag(long value)
    Write a fixed64 field to the stream.
    final void
    writeFloat(int fieldNumber, float value)
    Write a float field, including tag, to the stream.
    final void
    writeFloatNoTag(float value)
    Write a float field to the stream.
    final void
    writeGroup(int fieldNumber, MessageLite value)
    Deprecated.
    groups are deprecated.
    final void
    writeGroupNoTag(MessageLite value)
    Deprecated.
    groups are deprecated.
    abstract void
    writeInt32(int fieldNumber, int value)
    Write an int32 field, including tag, to the stream.
    abstract void
    writeInt32NoTag(int value)
    Write an int32 field to the stream.
    final void
    writeInt64(int fieldNumber, long value)
    Write an int64 field, including tag, to the stream.
    final void
    writeInt64NoTag(long value)
    Write an int64 field to the stream.
    abstract void
    writeLazy(byte[] value, int offset, int length)
    Writes a sequence of bytes.
    abstract void
    writeLazy(ByteBuffer value)
    Writes a sequence of bytes.
    abstract void
    writeMessage(int fieldNumber, MessageLite value)
    Write an embedded message field, including tag, to the stream.
    abstract void
    writeMessageNoTag(MessageLite value)
    Write an embedded message field to the stream.
    abstract void
    writeMessageSetExtension(int fieldNumber, MessageLite value)
    Write a MessageSet extension field to the stream.
    final void
    writeRawByte(byte value)
    Write a single byte.
    final void
    writeRawByte(int value)
    Write a single byte, represented by an integer value.
    final void
    writeRawBytes(byte[] value)
    Write an array of bytes.
    final void
    writeRawBytes(byte[] value, int offset, int length)
    Write part of an array of bytes.
    final void
    writeRawBytes(ByteString value)
    Write a byte string.
    abstract void
    writeRawBytes(ByteBuffer value)
    Write a ByteBuffer.
    final void
    writeRawLittleEndian32(int value)
    Deprecated.
    Use writeFixed32NoTag(int) instead.
    final void
    writeRawLittleEndian64(long value)
    Deprecated.
    Use writeFixed64NoTag(long) instead.
    abstract void
    writeRawMessageSetExtension(int fieldNumber, ByteString value)
    Write an unparsed MessageSet extension field to the stream.
    final void
    writeRawVarint32(int value)
    Deprecated.
    use writeUInt32NoTag(int) instead.
    final void
    writeRawVarint64(long value)
    Deprecated.
    use writeUInt64NoTag(long) instead.
    final void
    writeSFixed32(int fieldNumber, int value)
    Write an sfixed32 field, including tag, to the stream.
    final void
    writeSFixed32NoTag(int value)
    Write a sfixed32 field to the stream.
    final void
    writeSFixed64(int fieldNumber, long value)
    Write an sfixed64 field, including tag, to the stream.
    final void
    writeSFixed64NoTag(long value)
    Write a sfixed64 field to the stream.
    final void
    writeSInt32(int fieldNumber, int value)
    Write a sint32 field, including tag, to the stream.
    final void
    writeSInt32NoTag(int value)
    Write a sint32 field to the stream.
    final void
    writeSInt64(int fieldNumber, long value)
    Write an sint64 field, including tag, to the stream.
    final void
    writeSInt64NoTag(long value)
    Write a sint64 field to the stream.
    abstract void
    writeString(int fieldNumber, String value)
    Write a string field, including tag, to the stream.
    abstract void
    writeStringNoTag(String value)
    Write a string field to the stream.
    abstract void
    writeTag(int fieldNumber, int wireType)
    Encode and write a tag.
    abstract void
    writeUInt32(int fieldNumber, int value)
    Write a uint32 field, including tag, to the stream.
    abstract void
    writeUInt32NoTag(int value)
    Write a uint32 field to the stream.
    abstract void
    writeUInt64(int fieldNumber, long value)
    Write a uint64 field, including tag, to the stream.
    abstract void
    writeUInt64NoTag(long value)
    Write a uint64 field to the stream.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Method Details

    • newInstance

      public static CodedOutputStream newInstance(OutputStream output)
      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.

    • newInstance

      public static CodedOutputStream newInstance(OutputStream output, int bufferSize)
      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.

    • newInstance

      public static CodedOutputStream newInstance(byte[] flatArray)
      Create a new 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).

    • newInstance

      public static CodedOutputStream newInstance(byte[] flatArray, int offset, int length)
      Create a new 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).

    • newInstance

      public static CodedOutputStream newInstance(ByteBuffer buffer)
      Create a new CodedOutputStream that writes to the given ByteBuffer.

    • useDeterministicSerialization

      public void useDeterministicSerialization()
      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.

    • newInstance

      @Deprecated public static CodedOutputStream newInstance(ByteBuffer byteBuffer, int unused)
      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.
      Create a new CodedOutputStream that writes to the given ByteBuffer.

    • writeTag

      public abstract void writeTag(int fieldNumber, int wireType) throws IOException
      Encode and write a tag.
      Throws:
      IOException

    • writeInt32

      public abstract void writeInt32(int fieldNumber, int value) throws IOException
      Write an int32 field, including tag, to the stream.
      Throws:
      IOException

    • writeUInt32

      public abstract void writeUInt32(int fieldNumber, int value) throws IOException
      Write a uint32 field, including tag, to the stream.
      Throws:
      IOException

    • writeSInt32

      public final void writeSInt32(int fieldNumber, int value) throws IOException
      Write a sint32 field, including tag, to the stream.
      Throws:
      IOException

    • writeFixed32

      public abstract void writeFixed32(int fieldNumber, int value) throws IOException
      Write a fixed32 field, including tag, to the stream.
      Throws:
      IOException

    • writeSFixed32

      public final void writeSFixed32(int fieldNumber, int value) throws IOException
      Write an sfixed32 field, including tag, to the stream.
      Throws:
      IOException

    • writeInt64

      public final void writeInt64(int fieldNumber, long value) throws IOException
      Write an int64 field, including tag, to the stream.
      Throws:
      IOException

    • writeUInt64

      public abstract void writeUInt64(int fieldNumber, long value) throws IOException
      Write a uint64 field, including tag, to the stream.
      Throws:
      IOException

    • writeSInt64

      public final void writeSInt64(int fieldNumber, long value) throws IOException
      Write an sint64 field, including tag, to the stream.
      Throws:
      IOException

    • writeFixed64

      public abstract void writeFixed64(int fieldNumber, long value) throws IOException
      Write a fixed64 field, including tag, to the stream.
      Throws:
      IOException

    • writeSFixed64

      public final void writeSFixed64(int fieldNumber, long value) throws IOException
      Write an sfixed64 field, including tag, to the stream.
      Throws:
      IOException

    • writeFloat

      public final void writeFloat(int fieldNumber, float value) throws IOException
      Write a float field, including tag, to the stream.
      Throws:
      IOException

    • writeDouble

      public final void writeDouble(int fieldNumber, double value) throws IOException
      Write a double field, including tag, to the stream.
      Throws:
      IOException

    • writeBool

      public abstract void writeBool(int fieldNumber, boolean value) throws IOException
      Write a bool field, including tag, to the stream.
      Throws:
      IOException

    • writeEnum

      public final void writeEnum(int fieldNumber, int value) throws IOException
      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).
      Throws:
      IOException

    • writeString

      public abstract void writeString(int fieldNumber, String value) throws IOException
      Write a string field, including tag, to the stream.
      Throws:
      IOException

    • writeBytes

      public abstract void writeBytes(int fieldNumber, ByteString value) throws IOException
      Write a bytes field, including tag, to the stream.
      Throws:
      IOException

    • writeByteArray

      public abstract void writeByteArray(int fieldNumber, byte[] value) throws IOException
      Write a bytes field, including tag, to the stream.
      Throws:
      IOException

    • writeByteArray

      public abstract void writeByteArray(int fieldNumber, byte[] value, int offset, int length) throws IOException
      Write a bytes field, including tag, to the stream.
      Throws:
      IOException

    • writeByteBuffer

      public abstract void writeByteBuffer(int fieldNumber, ByteBuffer value) throws IOException
      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()).
      Throws:
      IOException

    • writeRawByte

      public final void writeRawByte(byte value) throws IOException
      Write a single byte.
      Throws:
      IOException

    • writeRawByte

      public final void writeRawByte(int value) throws IOException
      Write a single byte, represented by an integer value.
      Throws:
      IOException

    • writeRawBytes

      public final void writeRawBytes(byte[] value) throws IOException
      Write an array of bytes.
      Throws:
      IOException

    • writeRawBytes

      public final void writeRawBytes(byte[] value, int offset, int length) throws IOException
      Write part of an array of bytes.
      Throws:
      IOException

    • writeRawBytes

      public final void writeRawBytes(ByteString value) throws IOException
      Write a byte string.
      Throws:
      IOException

    • writeRawBytes

      public abstract void writeRawBytes(ByteBuffer value) throws IOException
      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()).
      Throws:
      IOException

    • writeMessage

      public abstract void writeMessage(int fieldNumber, MessageLite value) throws IOException
      Write an embedded message field, including tag, to the stream.
      Throws:
      IOException

    • writeMessageSetExtension

      public abstract void writeMessageSetExtension(int fieldNumber, MessageLite value) throws IOException
      Write a MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.
      Throws:
      IOException

    • writeRawMessageSetExtension

      public abstract void writeRawMessageSetExtension(int fieldNumber, ByteString value) throws IOException
      Write an unparsed MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.
      Throws:
      IOException

    • writeInt32NoTag

      public abstract void writeInt32NoTag(int value) throws IOException
      Write an int32 field to the stream.
      Throws:
      IOException

    • writeUInt32NoTag

      public abstract void writeUInt32NoTag(int value) throws IOException
      Write a uint32 field to the stream.
      Throws:
      IOException

    • writeSInt32NoTag

      public final void writeSInt32NoTag(int value) throws IOException
      Write a sint32 field to the stream.
      Throws:
      IOException

    • writeFixed32NoTag

      public abstract void writeFixed32NoTag(int value) throws IOException
      Write a fixed32 field to the stream.
      Throws:
      IOException

    • writeSFixed32NoTag

      public final void writeSFixed32NoTag(int value) throws IOException
      Write a sfixed32 field to the stream.
      Throws:
      IOException

    • writeInt64NoTag

      public final void writeInt64NoTag(long value) throws IOException
      Write an int64 field to the stream.
      Throws:
      IOException

    • writeUInt64NoTag

      public abstract void writeUInt64NoTag(long value) throws IOException
      Write a uint64 field to the stream.
      Throws:
      IOException

    • writeSInt64NoTag

      public final void writeSInt64NoTag(long value) throws IOException
      Write a sint64 field to the stream.
      Throws:
      IOException

    • writeFixed64NoTag

      public abstract void writeFixed64NoTag(long value) throws IOException
      Write a fixed64 field to the stream.
      Throws:
      IOException

    • writeSFixed64NoTag

      public final void writeSFixed64NoTag(long value) throws IOException
      Write a sfixed64 field to the stream.
      Throws:
      IOException

    • writeFloatNoTag

      public final void writeFloatNoTag(float value) throws IOException
      Write a float field to the stream.
      Throws:
      IOException

    • writeDoubleNoTag

      public final void writeDoubleNoTag(double value) throws IOException
      Write a double field to the stream.
      Throws:
      IOException

    • writeBoolNoTag

      public final void writeBoolNoTag(boolean value) throws IOException
      Write a bool field to the stream.
      Throws:
      IOException

    • writeEnumNoTag

      public final void writeEnumNoTag(int value) throws IOException
      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).
      Throws:
      IOException

    • writeStringNoTag

      public abstract void writeStringNoTag(String value) throws IOException
      Write a string field to the stream.
      Throws:
      IOException

    • writeBytesNoTag

      public abstract void writeBytesNoTag(ByteString value) throws IOException
      Write a bytes field to the stream.
      Throws:
      IOException

    • writeByteArrayNoTag

      public final void writeByteArrayNoTag(byte[] value) throws IOException
      Write a bytes field to the stream.
      Throws:
      IOException

    • writeMessageNoTag

      public abstract void writeMessageNoTag(MessageLite value) throws IOException
      Write an embedded message field to the stream.
      Throws:
      IOException

    • write

      @ExperimentalApi public abstract void write(byte value) throws IOException
      Description copied from class: ByteOutput
      Writes a single byte.
      Specified by:
      write in class ByteOutput
      Parameters:
      value - the byte to be written
      Throws:
      IOException - thrown if an error occurred while writing

    • write

      @ExperimentalApi public abstract void write(byte[] value, int offset, int length) throws IOException
      Description copied from class: ByteOutput
      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.

      Specified by:
      write in class ByteOutput
      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
      Throws:
      IOException - thrown if an error occurred while writing

    • writeLazy

      @ExperimentalApi public abstract void writeLazy(byte[] value, int offset, int length) throws IOException
      Description copied from class: ByteOutput
      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.

      Specified by:
      writeLazy in class ByteOutput
      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
      Throws:
      IOException - thrown if an error occurred while writing

    • write

      public abstract void write(ByteBuffer value) throws IOException
      Description copied from class: ByteOutput
      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.

      Specified by:
      write in class ByteOutput
      Parameters:
      value - the bytes to be written. Upon returning from this call, the position of this buffer will be set to the limit
      Throws:
      IOException - thrown if an error occurred while writing

    • writeLazy

      @ExperimentalApi public abstract void writeLazy(ByteBuffer value) throws IOException
      Description copied from class: ByteOutput
      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.

      Specified by:
      writeLazy in class ByteOutput
      Parameters:
      value - the bytes to be written. Upon returning from this call, the position of this buffer will be set to the limit
      Throws:
      IOException - thrown if an error occurred while writing

    • computeInt32Size

      public static int computeInt32Size(int fieldNumber, int value)
      Compute the number of bytes that would be needed to encode an int32 field, including tag.

    • computeUInt32Size

      public static int computeUInt32Size(int fieldNumber, int value)
      Compute the number of bytes that would be needed to encode a uint32 field, including tag.

    • computeSInt32Size

      public static int computeSInt32Size(int fieldNumber, int value)
      Compute the number of bytes that would be needed to encode an sint32 field, including tag.

    • computeFixed32Size

      public static int computeFixed32Size(int fieldNumber, int value)
      Compute the number of bytes that would be needed to encode a fixed32 field, including tag.

    • computeSFixed32Size

      public static int computeSFixed32Size(int fieldNumber, int value)
      Compute the number of bytes that would be needed to encode an sfixed32 field, including tag.

    • computeInt64Size

      public static int computeInt64Size(int fieldNumber, long value)
      Compute the number of bytes that would be needed to encode an int64 field, including tag.

    • computeUInt64Size

      public static int computeUInt64Size(int fieldNumber, long value)
      Compute the number of bytes that would be needed to encode a uint64 field, including tag.

    • computeSInt64Size

      public static int computeSInt64Size(int fieldNumber, long value)
      Compute the number of bytes that would be needed to encode an sint64 field, including tag.

    • computeFixed64Size

      public static int computeFixed64Size(int fieldNumber, long value)
      Compute the number of bytes that would be needed to encode a fixed64 field, including tag.

    • computeSFixed64Size

      public static int computeSFixed64Size(int fieldNumber, long value)
      Compute the number of bytes that would be needed to encode an sfixed64 field, including tag.

    • computeFloatSize

      public static int computeFloatSize(int fieldNumber, float value)
      Compute the number of bytes that would be needed to encode a float field, including tag.

    • computeDoubleSize

      public static int computeDoubleSize(int fieldNumber, double value)
      Compute the number of bytes that would be needed to encode a double field, including tag.

    • computeBoolSize

      public static int computeBoolSize(int fieldNumber, boolean value)
      Compute the number of bytes that would be needed to encode a bool field, including tag.

    • computeEnumSize

      public static int computeEnumSize(int fieldNumber, int value)
      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).

    • computeStringSize

      public static int computeStringSize(int fieldNumber, String value)
      Compute the number of bytes that would be needed to encode a string field, including tag.

    • computeBytesSize

      public static int computeBytesSize(int fieldNumber, ByteString value)
      Compute the number of bytes that would be needed to encode a bytes field, including tag.

    • computeByteArraySize

      public static int computeByteArraySize(int fieldNumber, byte[] value)
      Compute the number of bytes that would be needed to encode a bytes field, including tag.

    • computeByteBufferSize

      public static int computeByteBufferSize(int fieldNumber, ByteBuffer value)
      Compute the number of bytes that would be needed to encode a bytes field, including tag.

    • computeLazyFieldSize

      public static int computeLazyFieldSize(int fieldNumber, LazyFieldLite value)
      Compute the number of bytes that would be needed to encode an embedded message in lazy field, including tag.

    • computeMessageSize

      public static int computeMessageSize(int fieldNumber, MessageLite value)
      Compute the number of bytes that would be needed to encode an embedded message field, including tag.

    • computeMessageSetExtensionSize

      public static int computeMessageSetExtensionSize(int fieldNumber, MessageLite value)
      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.

    • computeRawMessageSetExtensionSize

      public 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. For historical reasons, the wire format differs from normal fields.

    • computeLazyFieldMessageSetExtensionSize

      public static int computeLazyFieldMessageSetExtensionSize(int fieldNumber, LazyFieldLite value)
      Compute the number of bytes that would be needed to encode a lazily parsed MessageSet extension field to the stream. For historical reasons, the wire format differs from normal fields.

    • computeTagSize

      public static int computeTagSize(int fieldNumber)
      Compute the number of bytes that would be needed to encode a tag.

    • computeInt32SizeNoTag

      public static int computeInt32SizeNoTag(int value)
      Compute the number of bytes that would be needed to encode an int32 field, excluding tag.

    • computeUInt32SizeNoTag

      public static int computeUInt32SizeNoTag(int value)
      Compute the number of bytes that would be needed to encode a uint32 field.

    • computeSInt32SizeNoTag

      public static int computeSInt32SizeNoTag(int value)
      Compute the number of bytes that would be needed to encode an sint32 field.

    • computeFixed32SizeNoTag

      public static int computeFixed32SizeNoTag(int unused)
      Compute the number of bytes that would be needed to encode a fixed32 field.

    • computeSFixed32SizeNoTag

      public static int computeSFixed32SizeNoTag(int unused)
      Compute the number of bytes that would be needed to encode an sfixed32 field.

    • computeInt64SizeNoTag

      public static int computeInt64SizeNoTag(long value)
      Compute the number of bytes that would be needed to encode an int64 field, including tag.

    • computeUInt64SizeNoTag

      public static int computeUInt64SizeNoTag(long value)
      Compute the number of bytes that would be needed to encode a uint64 field, including tag.

    • computeSInt64SizeNoTag

      public static int computeSInt64SizeNoTag(long value)
      Compute the number of bytes that would be needed to encode an sint64 field.

    • computeFixed64SizeNoTag

      public static int computeFixed64SizeNoTag(long unused)
      Compute the number of bytes that would be needed to encode a fixed64 field.

    • computeSFixed64SizeNoTag

      public static int computeSFixed64SizeNoTag(long unused)
      Compute the number of bytes that would be needed to encode an sfixed64 field.

    • computeFloatSizeNoTag

      public static int computeFloatSizeNoTag(float unused)
      Compute the number of bytes that would be needed to encode a float field, including tag.

    • computeDoubleSizeNoTag

      public static int computeDoubleSizeNoTag(double unused)
      Compute the number of bytes that would be needed to encode a double field, including tag.

    • computeBoolSizeNoTag

      public static int computeBoolSizeNoTag(boolean unused)
      Compute the number of bytes that would be needed to encode a bool field.

    • computeEnumSizeNoTag

      public static int computeEnumSizeNoTag(int value)
      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).

    • computeStringSizeNoTag

      public static int computeStringSizeNoTag(String value)
      Compute the number of bytes that would be needed to encode a string field.

    • computeLazyFieldSizeNoTag

      public static int computeLazyFieldSizeNoTag(LazyFieldLite value)
      Compute the number of bytes that would be needed to encode an embedded message stored in lazy field.

    • computeBytesSizeNoTag

      public static int computeBytesSizeNoTag(ByteString value)
      Compute the number of bytes that would be needed to encode a bytes field.

    • computeByteArraySizeNoTag

      public static int computeByteArraySizeNoTag(byte[] value)
      Compute the number of bytes that would be needed to encode a bytes field.

    • computeByteBufferSizeNoTag

      public static int computeByteBufferSizeNoTag(ByteBuffer value)
      Compute the number of bytes that would be needed to encode a bytes field.

    • computeMessageSizeNoTag

      public static int computeMessageSizeNoTag(MessageLite value)
      Compute the number of bytes that would be needed to encode an embedded message field.

    • encodeZigZag32

      public static int encodeZigZag32(int n)
      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.

    • encodeZigZag64

      public static long encodeZigZag64(long n)
      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.

    • flush

      public abstract void flush() throws IOException
      Flushes the stream and forces any buffered bytes to be written. This does not flush the underlying OutputStream.
      Throws:
      IOException

    • spaceLeft

      public abstract int spaceLeft()
      If writing to a flat array, return the space left in the array. Otherwise, throws UnsupportedOperationException.

    • checkNoSpaceLeft

      public final void checkNoSpaceLeft()
      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.

    • getTotalBytesWritten

      public abstract int getTotalBytesWritten()
      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.

    • writeGroup

      @Deprecated public final void writeGroup(int fieldNumber, MessageLite value) throws IOException
      Deprecated.
      groups are deprecated.
      Write a group field, including tag, to the stream.
      Throws:
      IOException

    • writeGroupNoTag

      @Deprecated public final void writeGroupNoTag(MessageLite value) throws IOException
      Deprecated.
      groups are deprecated.
      Write a group field to the stream.
      Throws:
      IOException

    • computeGroupSize

      @Deprecated public static int computeGroupSize(int fieldNumber, MessageLite value)
      Deprecated.
      groups are deprecated.
      Compute the number of bytes that would be needed to encode a group field, including tag.

    • computeGroupSizeNoTag

      @Deprecated @InlineMe(replacement="value.getSerializedSize()") public static int computeGroupSizeNoTag(MessageLite value)
      Deprecated.
      Compute the number of bytes that would be needed to encode a group field.

    • writeRawVarint32

      @Deprecated @InlineMe(replacement="this.writeUInt32NoTag(value)") public final void writeRawVarint32(int value) throws IOException
      Deprecated.
      use writeUInt32NoTag(int) instead.
      Encode and write a varint. value is treated as unsigned, so it won't be sign-extended if negative.
      Throws:
      IOException

    • writeRawVarint64

      @Deprecated @InlineMe(replacement="this.writeUInt64NoTag(value)") public final void writeRawVarint64(long value) throws IOException
      Deprecated.
      use writeUInt64NoTag(long) instead.
      Encode and write a varint.
      Throws:
      IOException

    • computeRawVarint32Size

      @Deprecated @InlineMe(replacement="CodedOutputStream.computeUInt32SizeNoTag(value)", imports="com.google.protobuf.CodedOutputStream") public static int computeRawVarint32Size(int value)
      Deprecated.
      use computeUInt32SizeNoTag(int) instead.
      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.

    • computeRawVarint64Size

      @Deprecated @InlineMe(replacement="CodedOutputStream.computeUInt64SizeNoTag(value)", imports="com.google.protobuf.CodedOutputStream") public static int computeRawVarint64Size(long value)
      Deprecated.
      use computeUInt64SizeNoTag(long) instead.
      Compute the number of bytes that would be needed to encode a varint.

    • writeRawLittleEndian32

      @Deprecated @InlineMe(replacement="this.writeFixed32NoTag(value)") public final void writeRawLittleEndian32(int value) throws IOException
      Deprecated.
      Use writeFixed32NoTag(int) instead.
      Write a little-endian 32-bit integer.
      Throws:
      IOException

    • writeRawLittleEndian64

      @Deprecated @InlineMe(replacement="this.writeFixed64NoTag(value)") public final void writeRawLittleEndian64(long value) throws IOException
      Deprecated.
      Use writeFixed64NoTag(long) instead.
      Write a little-endian 64-bit integer.
      Throws:
      IOException