ProtobufOutputEx (Java Chassis::Foundations::Protobuf 1.3.0 API)

java.lang.Object
- io.protostuff.WriteSession
- - io.protostuff.ProtobufOutputEx

All Implemented Interfaces:

OutputEx
```
public final class ProtobufOutputEx
extends io.protostuff.WriteSession
implements OutputEx
```
Forked and modified from protostuff
Protobuf serialization where the messages must be fully buffered on memory before it can be written to the socket ( OutputStream).

Author:

David Yu

Date created:

May 18, 2010

Nested Class Summary
- Nested classes/interfaces inherited from class io.protostuff.WriteSession
  io.protostuff.WriteSession.FlushHandler

Field Summary

Fields
Modifier and Type Field and Description

static int LITTLE_ENDIAN_32_SIZE

static int LITTLE_ENDIAN_64_SIZE
- Fields inherited from class io.protostuff.WriteSession
  flushHandler, head, nextBufferSize, out, sink, size, tail

Fields
Modifier and Type	Field and Description
`static int`	`LITTLE_ENDIAN_32_SIZE`
`static int`	`LITTLE_ENDIAN_64_SIZE`

Constructor Summary

Constructors
Constructor and Description
`ProtobufOutputEx()`
`ProtobufOutputEx(io.protostuff.LinkedBuffer buffer)`
`ProtobufOutputEx(io.protostuff.LinkedBuffer buffer, int nextBufferSize)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProtobufOutputEx`	`clear()` Resets this output for re-use.
`static int`	`computeRawVarint32Size(int value)` Compute the number of bytes that would be needed to encode a varint.
`static int`	`computeRawVarint64Size(long value)` Compute the number of bytes that would be needed to encode a varint.
`static int`	`encodeZigZag32(int n)` Encode a ZigZag-encoded 32-bit value.
`static long`	`encodeZigZag64(long n)` Encode a ZigZag-encoded 64-bit value.
`void`	`toOutputStream(OutputStream outputStream)`
`void`	`writeBool(int tag, int tagSize, boolean value)` Writes a boolean field.
`void`	`writeByteArray(int tag, int tagSize, byte[] bytes)` Writes a byte array field.
`void`	`writeByteRange(boolean utf8String, int tag, int tagSize, byte[] value, int offset, int length)` Writes a binary or a pre-encoded utf8 string.
`void`	`writeBytes(int tag, int tagSize, ByteBuffer value)` Writes a ByteBuffer field.
`void`	`writeBytes(int tag, int tagSize, io.protostuff.ByteString value)` Writes a ByteString(wraps byte array) field.
`void`	`writeDouble(int tag, int tagSize, double value)` Writes a double field.
`void`	`writeEnum(int tag, int tagSize, int number)` Writes a enum(its number) field.
`void`	`writeFixed32(int tag, int tagSize, int value)` Writes a fixed int(4 bytes) field.
`void`	`writeFixed64(int tag, int tagSize, long value)` Writes a fixed long(8 bytes) field.
`void`	`writeFloat(int tag, int tagSize, float value)` Writes a float field.
`void`	`writeInt32(int tag, int tagSize, int value)` Writes a variable int field.
`void`	`writeInt64(int tag, int tagSize, long value)` Writes a variable long field.
`<T> void`	`writeObject(int tag, int tagSize, T value, SchemaWriter<T> schemaWriter)` Writes an object(using its schema) field.
`void`	`writePackedBool(boolean value)`
`void`	`writePackedFixed32(int value)`
`void`	`writePackedFixed64(long value)`
`void`	`writePackedInt32(int value)`
`void`	`writePackedSInt32(int value)`
`void`	`writePackedUInt32(int value)`
`void`	`writePackedUInt64(long value)`
`static int`	`writeRawLittleEndian32(int value, byte[] buffer, int offset)` Writes the encoded little endian 32 and returns the bytes written
`static int`	`writeRawLittleEndian64(long value, byte[] buffer, int offset)` Writes the encoded little endian 64 and returns the bytes written
`static void`	`writeRawVarInt32(int value, byte[] buf, int offset)` Encode and write a varint to the byte array
`static io.protostuff.LinkedBuffer`	`writeRawVarInt32(int value, io.protostuff.WriteSession session, io.protostuff.LinkedBuffer lb)` Returns the buffer encoded with the variable int 32.
`void`	`writeScalarBool(int tag, int tagSize, boolean value)`
`void`	`writeScalarDouble(int tag, int tagSize, double value)`
`void`	`writeScalarEnum(int tag, int tagSize, int value)`
`void`	`writeScalarFixed32(int tag, int tagSize, int value)`
`void`	`writeScalarFixed64(int tag, int tagSize, long value)`
`void`	`writeScalarFloat(int tag, int tagSize, float value)`
`void`	`writeScalarInt32(int tag, int tagSize, int value)`
`void`	`writeScalarInt64(int tag, int tagSize, long value)`
`void`	`writeScalarSFixed32(int tag, int tagSize, int value)`
`void`	`writeScalarSFixed64(int tag, int tagSize, long value)`
`void`	`writeScalarSInt32(int tag, int tagSize, int value)`
`void`	`writeScalarSInt64(int tag, int tagSize, long value)`
`void`	`writeScalarString(int tag, int tagSize, String value)`
`void`	`writeScalarUInt32(int tag, int tagSize, int value)`
`void`	`writeScalarUInt64(int tag, int tagSize, long value)`
`void`	`writeSFixed32(int tag, int tagSize, int value)` Writes a signed+fixed int(4 bytes) field.
`void`	`writeSFixed64(int tag, int tagSize, long value)` Writes a signed+fixed long(8 bytes) field.
`void`	`writeSInt32(int tag, int tagSize, int value)` Writes a signed int field.
`void`	`writeSInt64(int tag, int tagSize, long value)` Writes a signed long field.
`void`	`writeString(int tag, int tagSize, String value)` Writes a String field.
`static io.protostuff.LinkedBuffer`	`writeTagAndByteArray(int tag, int tagSize, byte[] value, int offset, int valueLen, io.protostuff.WriteSession session, io.protostuff.LinkedBuffer lb)` Returns the buffer encoded with the tag and byte array
`static io.protostuff.LinkedBuffer`	`writeTagAndRawLittleEndian32(int tag, int tagSize, int value, io.protostuff.WriteSession session, io.protostuff.LinkedBuffer lb)` Returns the buffer encoded with the tag and little endian 32
`static io.protostuff.LinkedBuffer`	`writeTagAndRawLittleEndian64(int tag, int tagSize, long value, io.protostuff.WriteSession session, io.protostuff.LinkedBuffer lb)` Returns the buffer encoded with the tag and little endian 64
`static io.protostuff.LinkedBuffer`	`writeTagAndRawVarInt32(int tag, int tagSize, int value, io.protostuff.WriteSession session, io.protostuff.LinkedBuffer lb)` Returns the buffer encoded with the tag and var int 32
`static io.protostuff.LinkedBuffer`	`writeTagAndRawVarInt64(int tag, int tagSize, long value, io.protostuff.WriteSession session, io.protostuff.LinkedBuffer lb)` Returns the buffer encoded with the tag and var int 64
`void`	`writeUInt32(int tag, int tagSize, int value)` Writes an unsigned int field.
`void`	`writeUInt64(int tag, int tagSize, long value)` Writes an unsigned long field.

Methods inherited from class io.protostuff.WriteSession
flush, flush, flush, getSize, reset, toByteArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.protostuff.OutputEx
toByteArray, writePackedDouble, writePackedEnum, writePackedFloat, writePackedInt64, writePackedSFixed32, writePackedSFixed64, writePackedSInt64

Field Detail
- LITTLE_ENDIAN_32_SIZE
```
public static final int LITTLE_ENDIAN_32_SIZE
```
  See Also:
  
  Constant Field Values
- LITTLE_ENDIAN_64_SIZE
```
public static final int LITTLE_ENDIAN_64_SIZE
```
  See Also:
  
  Constant Field Values

Constructor Detail

ProtobufOutputEx
```
public ProtobufOutputEx()
```

ProtobufOutputEx

public ProtobufOutputEx(io.protostuff.LinkedBuffer buffer)

ProtobufOutputEx

public ProtobufOutputEx(io.protostuff.LinkedBuffer buffer,
                        int nextBufferSize)

Method Detail

clear
```
public ProtobufOutputEx clear()
```
Resets this output for re-use.

Overrides:

clear in class io.protostuff.WriteSession

writeInt32

public final void writeInt32(int tag,
                             int tagSize,
                             int value)

Description copied from interface: OutputEx

Writes a variable int field.

Specified by:: writeInt32 in interface OutputEx

writeUInt32

public final void writeUInt32(int tag,
                              int tagSize,
                              int value)

Description copied from interface: OutputEx

Writes an unsigned int field.

Specified by:: writeUInt32 in interface OutputEx

writeSInt32

public final void writeSInt32(int tag,
                              int tagSize,
                              int value)

Description copied from interface: OutputEx

Writes a signed int field.

Specified by:: writeSInt32 in interface OutputEx

writeFixed32
```
public final void writeFixed32(int tag,
                               int tagSize,
                               int value)
```
Description copied from interface: OutputEx

Writes a fixed int(4 bytes) field.

Specified by:

writeFixed32 in interface OutputEx

writeSFixed32
```
public final void writeSFixed32(int tag,
                                int tagSize,
                                int value)
```
Description copied from interface: OutputEx

Writes a signed+fixed int(4 bytes) field.

Specified by:

writeSFixed32 in interface OutputEx

writeInt64

public final void writeInt64(int tag,
                             int tagSize,
                             long value)

Description copied from interface: OutputEx

Writes a variable long field.

Specified by:: writeInt64 in interface OutputEx

writeUInt64

public final void writeUInt64(int tag,
                              int tagSize,
                              long value)

Description copied from interface: OutputEx

Writes an unsigned long field.

Specified by:: writeUInt64 in interface OutputEx

writeSInt64

public final void writeSInt64(int tag,
                              int tagSize,
                              long value)

Description copied from interface: OutputEx

Writes a signed long field.

Specified by:: writeSInt64 in interface OutputEx

writeFixed64
```
public final void writeFixed64(int tag,
                               int tagSize,
                               long value)
```
Description copied from interface: OutputEx

Writes a fixed long(8 bytes) field.

Specified by:

writeFixed64 in interface OutputEx

writeSFixed64
```
public final void writeSFixed64(int tag,
                                int tagSize,
                                long value)
```
Description copied from interface: OutputEx

Writes a signed+fixed long(8 bytes) field.

Specified by:

writeSFixed64 in interface OutputEx

writeFloat

public final void writeFloat(int tag,
                             int tagSize,
                             float value)

Description copied from interface: OutputEx

Writes a float field.

Specified by:: writeFloat in interface OutputEx

writeDouble

public final void writeDouble(int tag,
                              int tagSize,
                              double value)

Description copied from interface: OutputEx

Writes a double field.

Specified by:: writeDouble in interface OutputEx

writeBool

public final void writeBool(int tag,
                            int tagSize,
                            boolean value)

Description copied from interface: OutputEx

Writes a boolean field.

Specified by:: writeBool in interface OutputEx

writeEnum
```
public final void writeEnum(int tag,
                            int tagSize,
                            int number)
```
Description copied from interface: OutputEx

Writes a enum(its number) field.

Specified by:

writeEnum in interface OutputEx

writeString

public final void writeString(int tag,
                              int tagSize,
                              String value)

Description copied from interface: OutputEx

Writes a String field.

Specified by:: writeString in interface OutputEx

writeBytes

public final void writeBytes(int tag,
                             int tagSize,
                             io.protostuff.ByteString value)

Description copied from interface: OutputEx

Writes a ByteString(wraps byte array) field.

Specified by:: writeBytes in interface OutputEx

writeByteArray

public final void writeByteArray(int tag,
                                 int tagSize,
                                 byte[] bytes)

Description copied from interface: OutputEx

Writes a byte array field.

Specified by:: writeByteArray in interface OutputEx

writeByteRange

public final void writeByteRange(boolean utf8String,
                                 int tag,
                                 int tagSize,
                                 byte[] value,
                                 int offset,
                                 int length)

Description copied from interface: OutputEx

Writes a binary or a pre-encoded utf8 string.

Specified by:: writeByteRange in interface OutputEx

writeObject

public final <T> void writeObject(int tag,
                                  int tagSize,
                                  T value,
                                  SchemaWriter<T> schemaWriter)
                           throws IOException

Description copied from interface: OutputEx

Writes an object(using its schema) field.

Specified by:: writeObject in interface OutputEx
Throws:: IOException

writeRawVarInt32

public static io.protostuff.LinkedBuffer writeRawVarInt32(int value,
                                                          io.protostuff.WriteSession session,
                                                          io.protostuff.LinkedBuffer lb)

Returns the buffer encoded with the variable int 32.

writeTagAndByteArray

public static io.protostuff.LinkedBuffer writeTagAndByteArray(int tag,
                                                              int tagSize,
                                                              byte[] value,
                                                              int offset,
                                                              int valueLen,
                                                              io.protostuff.WriteSession session,
                                                              io.protostuff.LinkedBuffer lb)

Returns the buffer encoded with the tag and byte array

writeTagAndRawVarInt32

public static io.protostuff.LinkedBuffer writeTagAndRawVarInt32(int tag,
                                                                int tagSize,
                                                                int value,
                                                                io.protostuff.WriteSession session,
                                                                io.protostuff.LinkedBuffer lb)

Returns the buffer encoded with the tag and var int 32

writeTagAndRawVarInt64

public static io.protostuff.LinkedBuffer writeTagAndRawVarInt64(int tag,
                                                                int tagSize,
                                                                long value,
                                                                io.protostuff.WriteSession session,
                                                                io.protostuff.LinkedBuffer lb)

Returns the buffer encoded with the tag and var int 64

writeTagAndRawLittleEndian32

public static io.protostuff.LinkedBuffer writeTagAndRawLittleEndian32(int tag,
                                                                      int tagSize,
                                                                      int value,
                                                                      io.protostuff.WriteSession session,
                                                                      io.protostuff.LinkedBuffer lb)

Returns the buffer encoded with the tag and little endian 32

writeTagAndRawLittleEndian64

public static io.protostuff.LinkedBuffer writeTagAndRawLittleEndian64(int tag,
                                                                      int tagSize,
                                                                      long value,
                                                                      io.protostuff.WriteSession session,
                                                                      io.protostuff.LinkedBuffer lb)

Returns the buffer encoded with the tag and little endian 64

writeRawVarInt32

public static void writeRawVarInt32(int value,
                                    byte[] buf,
                                    int offset)
                             throws IOException

Encode and write a varint to the byte array

Throws:: IOException

writeRawLittleEndian32

public static int writeRawLittleEndian32(int value,
                                         byte[] buffer,
                                         int offset)

Writes the encoded little endian 32 and returns the bytes written

writeRawLittleEndian64

public static int writeRawLittleEndian64(long value,
                                         byte[] buffer,
                                         int offset)

Writes the encoded little endian 64 and returns the bytes written

computeRawVarint32Size
```
public static int computeRawVarint32Size(int value)
```
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
```
public static int computeRawVarint64Size(long value)
```
Compute the number of bytes that would be needed to encode a varint.

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.

writeBytes

public final void writeBytes(int tag,
                             int tagSize,
                             ByteBuffer value)

Writes a ByteBuffer field.

Specified by:: writeBytes in interface OutputEx

toOutputStream

public void toOutputStream(OutputStream outputStream)
                    throws IOException

Throws:: IOException

writePackedInt32
```
public final void writePackedInt32(int value)
```
Specified by:

writePackedInt32 in interface OutputEx

writeScalarInt32

public final void writeScalarInt32(int tag,
                                   int tagSize,
                                   int value)

Specified by:: writeScalarInt32 in interface OutputEx

writeScalarInt64

public final void writeScalarInt64(int tag,
                                   int tagSize,
                                   long value)

Specified by:: writeScalarInt64 in interface OutputEx

writePackedUInt32
```
public final void writePackedUInt32(int value)
```
Specified by:

writePackedUInt32 in interface OutputEx

writeScalarUInt32

public final void writeScalarUInt32(int tag,
                                    int tagSize,
                                    int value)

Specified by:: writeScalarUInt32 in interface OutputEx

writePackedUInt64
```
public final void writePackedUInt64(long value)
```
Specified by:

writePackedUInt64 in interface OutputEx

writeScalarUInt64

public final void writeScalarUInt64(int tag,
                                    int tagSize,
                                    long value)

Specified by:: writeScalarUInt64 in interface OutputEx

writePackedSInt32
```
public final void writePackedSInt32(int value)
```
Specified by:

writePackedSInt32 in interface OutputEx

writeScalarSInt32

public final void writeScalarSInt32(int tag,
                                    int tagSize,
                                    int value)

Specified by:: writeScalarSInt32 in interface OutputEx

writeScalarSInt64

public final void writeScalarSInt64(int tag,
                                    int tagSize,
                                    long value)

Specified by:: writeScalarSInt64 in interface OutputEx

writePackedFixed32
```
public final void writePackedFixed32(int value)
```
Specified by:

writePackedFixed32 in interface OutputEx

writeScalarFixed32

public final void writeScalarFixed32(int tag,
                                     int tagSize,
                                     int value)

Specified by:: writeScalarFixed32 in interface OutputEx

writePackedFixed64
```
public final void writePackedFixed64(long value)
```
Specified by:

writePackedFixed64 in interface OutputEx

writeScalarFixed64

public final void writeScalarFixed64(int tag,
                                     int tagSize,
                                     long value)

Specified by:: writeScalarFixed64 in interface OutputEx

writeScalarSFixed32

public final void writeScalarSFixed32(int tag,
                                      int tagSize,
                                      int value)

Specified by:: writeScalarSFixed32 in interface OutputEx

writeScalarSFixed64

public final void writeScalarSFixed64(int tag,
                                      int tagSize,
                                      long value)

Specified by:: writeScalarSFixed64 in interface OutputEx

writeScalarFloat

public final void writeScalarFloat(int tag,
                                   int tagSize,
                                   float value)

Specified by:: writeScalarFloat in interface OutputEx

writeScalarDouble

public final void writeScalarDouble(int tag,
                                    int tagSize,
                                    double value)

Specified by:: writeScalarDouble in interface OutputEx

writePackedBool
```
public final void writePackedBool(boolean value)
```
Specified by:

writePackedBool in interface OutputEx

writeScalarBool

public final void writeScalarBool(int tag,
                                  int tagSize,
                                  boolean value)

Specified by:: writeScalarBool in interface OutputEx

writeScalarEnum

public final void writeScalarEnum(int tag,
                                  int tagSize,
                                  int value)

Specified by:: writeScalarEnum in interface OutputEx

writeScalarString

public final void writeScalarString(int tag,
                                    int tagSize,
                                    String value)

Specified by:: writeScalarString in interface OutputEx

Class ProtobufOutputEx

Nested Class Summary

Nested classes/interfaces inherited from class io.protostuff.WriteSession

Field Summary

Fields inherited from class io.protostuff.WriteSession

Constructor Summary

Method Summary

Methods inherited from class io.protostuff.WriteSession

Methods inherited from class java.lang.Object

Methods inherited from interface io.protostuff.OutputEx

Field Detail

LITTLE_ENDIAN_32_SIZE

LITTLE_ENDIAN_64_SIZE

Constructor Detail

ProtobufOutputEx

ProtobufOutputEx

ProtobufOutputEx

Method Detail

clear

writeInt32

writeUInt32

writeSInt32

writeFixed32

writeSFixed32

writeInt64

writeUInt64

writeSInt64

writeFixed64

writeSFixed64

writeFloat

writeDouble

writeBool

writeEnum

writeString

writeBytes

writeByteArray

writeByteRange

writeObject

writeRawVarInt32

writeTagAndByteArray

writeTagAndRawVarInt32

writeTagAndRawVarInt64

writeTagAndRawLittleEndian32

writeTagAndRawLittleEndian64

writeRawVarInt32

writeRawLittleEndian32

writeRawLittleEndian64

computeRawVarint32Size

computeRawVarint64Size

encodeZigZag32

encodeZigZag64

writeBytes

toOutputStream

writePackedInt32

writeScalarInt32

writeScalarInt64

writePackedUInt32

writeScalarUInt32

writePackedUInt64

writeScalarUInt64

writePackedSInt32

writeScalarSInt32

writeScalarSInt64

writePackedFixed32

writeScalarFixed32

writePackedFixed64

writeScalarFixed64

writeScalarSFixed32

writeScalarSFixed64

writeScalarFloat

writeScalarDouble

writePackedBool

writeScalarBool

writeScalarEnum

writeScalarString