com.cinnober.msgcodec.blink

Class BlinkOutput

java.lang.Object

com.cinnober.msgcodec.blink.BlinkOutput

public class BlinkOutput
extends java.lang.Object

Methods for writing primitive Blink data types.

See Also:

BlinkInput

Method Summary

Modifier and Type	Method and Description
static int	sizeOfSignedVLC(java.math.BigInteger value) Returns the size in bytes of a signed variable-length coded value.
static int	sizeOfSignedVLC(long value) Returns the size in bytes of a signed variable-length coded value.
static int	sizeOfUnsignedVLC(long value) Returns the size in bytes of an unsigned variable-length coded value.
static void	writeBigDecimal(com.cinnober.msgcodec.io.ByteSink out, java.math.BigDecimal value) Write a big decimal number.
static void	writeBigDecimalNull(com.cinnober.msgcodec.io.ByteSink out, java.math.BigDecimal value) Write a nullable big decimal number.
static void	writeBigInt(com.cinnober.msgcodec.io.ByteSink out, java.math.BigInteger value) Write a signed big integer.
static void	writeBigIntNull(com.cinnober.msgcodec.io.ByteSink out, java.math.BigInteger value) Write a nullable signed big integer.
static void	writeBinary(com.cinnober.msgcodec.io.ByteSink out, byte[] value) Write binary data.
static void	writeBinaryNull(com.cinnober.msgcodec.io.ByteSink out, byte[] value) Write nullable binary data.
static void	writeBoolean(com.cinnober.msgcodec.io.ByteSink out, boolean value) Write a boolean.
static void	writeBooleanNull(com.cinnober.msgcodec.io.ByteSink out, java.lang.Boolean value) Write a nullable boolean.
static void	writeDecimal(com.cinnober.msgcodec.io.ByteSink out, java.math.BigDecimal value) Write a decimal number.
static void	writeDecimalNull(com.cinnober.msgcodec.io.ByteSink out, java.math.BigDecimal value) Write a nullable decimal number.
static void	writeFloat32(com.cinnober.msgcodec.io.ByteSink out, float value) Write a 32-bit floating point number.
static void	writeFloat32Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Float value) Write a nullable 32-bit floating point number.
static void	writeFloat64(com.cinnober.msgcodec.io.ByteSink out, double value) Write a 64-bit floating point number.
static void	writeFloat64Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Double value) Write a nullable 64-bit floating point number.
static void	writeInt16(com.cinnober.msgcodec.io.ByteSink out, short value) Write a signed 16-bit integer.
static void	writeInt16Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Short value) Write a nullable signed 16-bit integer.
static void	writeInt32(com.cinnober.msgcodec.io.ByteSink out, int value) Write a signed 32-bit integer.
static void	writeInt32Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Integer value) Write a nullable signed 32-bit integer.
static void	writeInt64(com.cinnober.msgcodec.io.ByteSink out, long value) Write a signed 64-bit integer.
static void	writeInt64Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Long value) Write a nullable signed 64-bit integer.
static void	writeInt8(com.cinnober.msgcodec.io.ByteSink out, byte value) Write a signed 8-bit integer.
static void	writeInt8Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Byte value) Write a nullable signed 8-bit integer.
static void	writeNull(com.cinnober.msgcodec.io.ByteSink out) Write the null (0xc0) value.
static void	writePresenceByte(com.cinnober.msgcodec.io.ByteSink out, boolean value) Write a boolean.
static void	writeSignedVLC(com.cinnober.msgcodec.io.ByteSink out, java.math.BigInteger value) Write a signed variable-length code value.
static void	writeSignedVLC(com.cinnober.msgcodec.io.ByteSink out, long value) Write a signed variable-length code value.
static void	writeStringUTF8(com.cinnober.msgcodec.io.ByteSink out, java.lang.String value) Write a unicode string.
static void	writeStringUTF8Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.String value) Write a nullable unicode string.
static void	writeUInt16(com.cinnober.msgcodec.io.ByteSink out, short value) Write an unsigned 16-bit integer.
static void	writeUInt16Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Short value) Write a nullable unsigned 16-bit integer.
static void	writeUInt32(com.cinnober.msgcodec.io.ByteSink out, int value) Write an unsigned 32-bit integer.
static void	writeUInt32Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Integer value) Write a nullable unsigned 32-bit integer.
static void	writeUInt64(com.cinnober.msgcodec.io.ByteSink out, long value) Write an unsigned 64-bit integer.
static void	writeUInt64Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Long value) Write a nullable unsigned 64-bit integer.
static void	writeUInt8(com.cinnober.msgcodec.io.ByteSink out, byte value) Write an unsigned 8-bit integer.
static void	writeUInt8Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Byte value) Write a nullable unsigned 8-bit integer.
static void	writeUnsignedVLC(com.cinnober.msgcodec.io.ByteSink out, long value) Write an unsigned variable-length code value.

Methods inherited from class java.lang.Object

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

Method Detail

writeNull

public static void writeNull(com.cinnober.msgcodec.io.ByteSink out)
                      throws java.io.IOException

Write the null (0xc0) value.

Parameters:

out - the output stream to write to, not null.

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt8

public static void writeInt8(com.cinnober.msgcodec.io.ByteSink out,
                             byte value)
                      throws java.io.IOException

Write a signed 8-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt16

public static void writeInt16(com.cinnober.msgcodec.io.ByteSink out,
                              short value)
                       throws java.io.IOException

Write a signed 16-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt32

public static void writeInt32(com.cinnober.msgcodec.io.ByteSink out,
                              int value)
                       throws java.io.IOException

Write a signed 32-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt64

public static void writeInt64(com.cinnober.msgcodec.io.ByteSink out,
                              long value)
                       throws java.io.IOException

Write a signed 64-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt8

public static void writeUInt8(com.cinnober.msgcodec.io.ByteSink out,
                              byte value)
                       throws java.io.IOException

Write an unsigned 8-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt16

public static void writeUInt16(com.cinnober.msgcodec.io.ByteSink out,
                               short value)
                        throws java.io.IOException

Write an unsigned 16-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt32

public static void writeUInt32(com.cinnober.msgcodec.io.ByteSink out,
                               int value)
                        throws java.io.IOException

Write an unsigned 32-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt64

public static void writeUInt64(com.cinnober.msgcodec.io.ByteSink out,
                               long value)
                        throws java.io.IOException

Write an unsigned 64-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt8Null

public static void writeInt8Null(com.cinnober.msgcodec.io.ByteSink out,
                                 java.lang.Byte value)
                          throws java.io.IOException

Write a nullable signed 8-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt16Null

public static void writeInt16Null(com.cinnober.msgcodec.io.ByteSink out,
                                  java.lang.Short value)
                           throws java.io.IOException

Write a nullable signed 16-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt32Null

public static void writeInt32Null(com.cinnober.msgcodec.io.ByteSink out,
                                  java.lang.Integer value)
                           throws java.io.IOException

Write a nullable signed 32-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeInt64Null

public static void writeInt64Null(com.cinnober.msgcodec.io.ByteSink out,
                                  java.lang.Long value)
                           throws java.io.IOException

Write a nullable signed 64-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt8Null

public static void writeUInt8Null(com.cinnober.msgcodec.io.ByteSink out,
                                  java.lang.Byte value)
                           throws java.io.IOException

Write a nullable unsigned 8-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt16Null

public static void writeUInt16Null(com.cinnober.msgcodec.io.ByteSink out,
                                   java.lang.Short value)
                            throws java.io.IOException

Write a nullable unsigned 16-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt32Null

public static void writeUInt32Null(com.cinnober.msgcodec.io.ByteSink out,
                                   java.lang.Integer value)
                            throws java.io.IOException

Write a nullable unsigned 32-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUInt64Null

public static void writeUInt64Null(com.cinnober.msgcodec.io.ByteSink out,
                                   java.lang.Long value)
                            throws java.io.IOException

Write a nullable unsigned 64-bit integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeBigIntNull

public static void writeBigIntNull(com.cinnober.msgcodec.io.ByteSink out,
                                   java.math.BigInteger value)
                            throws java.io.IOException

Write a nullable signed big integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeBigInt

public static void writeBigInt(com.cinnober.msgcodec.io.ByteSink out,
                               java.math.BigInteger value)
                        throws java.io.IOException

Write a signed big integer.

Parameters:

out - the output stream to write to, not null.

value - the value to be written, not null

Throws:

java.io.IOException - if the underlying stream throws an exception

writeFloat32

public static void writeFloat32(com.cinnober.msgcodec.io.ByteSink out,
                                float value)
                         throws java.io.IOException

Write a 32-bit floating point number.

Since the Blink protocol does not support 32-bit floating point numbers, the value is written as a 64-bit floating point number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

See Also:

writeFloat64(ByteSink, double)

writeFloat32Null

public static void writeFloat32Null(com.cinnober.msgcodec.io.ByteSink out,
                                    java.lang.Float value)
                             throws java.io.IOException

Write a nullable 32-bit floating point number.

Since the Blink protocol does not support 32-bit floating point numbers, the value is written as a 64-bit floating point number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

See Also:

writeFloat64Null(ByteSink, Double)

writeFloat64

public static void writeFloat64(com.cinnober.msgcodec.io.ByteSink out,
                                double value)
                         throws java.io.IOException

Write a 64-bit floating point number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeFloat64Null

public static void writeFloat64Null(com.cinnober.msgcodec.io.ByteSink out,
                                    java.lang.Double value)
                             throws java.io.IOException

Write a nullable 64-bit floating point number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeDecimal

public static void writeDecimal(com.cinnober.msgcodec.io.ByteSink out,
                                java.math.BigDecimal value)
                         throws java.io.IOException,
                                java.lang.NullPointerException

Write a decimal number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written, not null

Throws:

java.io.IOException - if the underlying stream throws an exception

java.lang.NullPointerException - if value is null

writeDecimalNull

public static void writeDecimalNull(com.cinnober.msgcodec.io.ByteSink out,
                                    java.math.BigDecimal value)
                             throws java.io.IOException

Write a nullable decimal number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeBigDecimal

public static void writeBigDecimal(com.cinnober.msgcodec.io.ByteSink out,
                                   java.math.BigDecimal value)
                            throws java.io.IOException,
                                   java.lang.NullPointerException

Write a big decimal number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written, not null

Throws:

java.io.IOException - if the underlying stream throws an exception

java.lang.NullPointerException - if value is null

writeBigDecimalNull

public static void writeBigDecimalNull(com.cinnober.msgcodec.io.ByteSink out,
                                       java.math.BigDecimal value)
                                throws java.io.IOException

Write a nullable big decimal number.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writePresenceByte

public static void writePresenceByte(com.cinnober.msgcodec.io.ByteSink out,
                                     boolean value)
                              throws java.io.IOException

Write a boolean.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeBoolean

public static void writeBoolean(com.cinnober.msgcodec.io.ByteSink out,
                                boolean value)
                         throws java.io.IOException

Write a boolean.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeBooleanNull

public static void writeBooleanNull(com.cinnober.msgcodec.io.ByteSink out,
                                    java.lang.Boolean value)
                             throws java.io.IOException

Write a nullable boolean.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeStringUTF8

public static void writeStringUTF8(com.cinnober.msgcodec.io.ByteSink out,
                                   java.lang.String value)
                            throws java.io.IOException

Write a unicode string.

Parameters:

out - the output stream to write to, not null.

value - the value to be written, not null

Throws:

java.io.IOException - if the underlying stream throws an exception

java.lang.NullPointerException - if value is null

writeStringUTF8Null

public static void writeStringUTF8Null(com.cinnober.msgcodec.io.ByteSink out,
                                       java.lang.String value)
                                throws java.io.IOException

Write a nullable unicode string.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeBinary

public static void writeBinary(com.cinnober.msgcodec.io.ByteSink out,
                               byte[] value)
                        throws java.io.IOException

Write binary data.

Parameters:

out - the output stream to write to, not null.

value - the value to be written, not null

Throws:

java.io.IOException - if the underlying stream throws an exception

java.lang.NullPointerException - if value is null

writeBinaryNull

public static void writeBinaryNull(com.cinnober.msgcodec.io.ByteSink out,
                                   byte[] value)
                            throws java.io.IOException

Write nullable binary data.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeSignedVLC

public static void writeSignedVLC(com.cinnober.msgcodec.io.ByteSink out,
                                  java.math.BigInteger value)
                           throws java.io.IOException

Write a signed variable-length code value.

Parameters:

out - the output stream to write to, not null.

value - the value to be written, not null

Throws:

java.io.IOException - if the underlying stream throws an exception

writeSignedVLC

public static void writeSignedVLC(com.cinnober.msgcodec.io.ByteSink out,
                                  long value)
                           throws java.io.IOException

Write a signed variable-length code value.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

writeUnsignedVLC

public static void writeUnsignedVLC(com.cinnober.msgcodec.io.ByteSink out,
                                    long value)
                             throws java.io.IOException

Write an unsigned variable-length code value.

Parameters:

out - the output stream to write to, not null.

value - the value to be written

Throws:

java.io.IOException - if the underlying stream throws an exception

sizeOfSignedVLC

public static final int sizeOfSignedVLC(long value)

Returns the size in bytes of a signed variable-length coded value.

Parameters:

value - the value

Returns:

the number of bytes, always in the range [1, 9].

sizeOfSignedVLC

public static final int sizeOfSignedVLC(java.math.BigInteger value)

Returns the size in bytes of a signed variable-length coded value.

Parameters:

value - the value, not null.

Returns:

the number of bytes.

sizeOfUnsignedVLC

public static final int sizeOfUnsignedVLC(long value)

Returns the size in bytes of an unsigned variable-length coded value.

Parameters:

value - the value

Returns:

the number of bytes, always in the range [1, 9].