com.cinnober.msgcodec.blink

Class NativeBlinkOutput

java.lang.Object

com.cinnober.msgcodec.blink.NativeBlinkOutput

public class NativeBlinkOutput
extends java.lang.Object

Methods for writing primitive Native Blink data types.

Write methods for variable size data types come in two flavors: writeInlineXxx and writeDataXxx for inline and data area respectively.

See Also:

NativeBlinkInput

Method Summary

Modifier and Type	Method and Description
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	writeDataBigDecimal(com.cinnober.msgcodec.io.ByteSink out, java.math.BigDecimal value) Write a big decimal number.
static void	writeDataBigInt(com.cinnober.msgcodec.io.ByteSink out, java.math.BigInteger value) Write a signed big integer.
static void	writeDataBinary(com.cinnober.msgcodec.io.ByteSink out, byte[] value) Write binary data.
static void	writeDataStringUTF8(com.cinnober.msgcodec.io.ByteSink out, java.lang.String value) Write a unicode string.
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	writeInlineBinary(com.cinnober.msgcodec.io.ByteSink out, byte[] value, int maxLength) Write binary data.
static void	writeInlineBinaryNull(com.cinnober.msgcodec.io.ByteSink out, byte[] value, int maxLength) Write nullable binary data.
static void	writeInlineStringUTF8(com.cinnober.msgcodec.io.ByteSink out, java.lang.String value, int maxLength) Write a unicode string.
static void	writeInlineStringUTF8Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.String value, int maxLength) Write a nullable unicode string.
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	writeUInt16(com.cinnober.msgcodec.io.ByteSink out, short value)
static void	writeUInt16Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Short value)
static void	writeUInt32(com.cinnober.msgcodec.io.ByteSink out, int value)
static void	writeUInt32Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Integer value)
static void	writeUInt64(com.cinnober.msgcodec.io.ByteSink out, long value)
static void	writeUInt64Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Long value)
static void	writeUInt8(com.cinnober.msgcodec.io.ByteSink out, byte value)
static void	writeUInt8Null(com.cinnober.msgcodec.io.ByteSink out, java.lang.Byte value)

Methods inherited from class java.lang.Object

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

Method Detail

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

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

writeUInt8

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

Throws:

java.io.IOException

writeUInt8Null

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

Throws:

java.io.IOException

writeUInt16

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

Throws:

java.io.IOException

writeUInt16Null

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

Throws:

java.io.IOException

writeUInt32

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

Throws:

java.io.IOException

writeUInt32Null

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

Throws:

java.io.IOException

writeUInt64

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

Throws:

java.io.IOException

writeUInt64Null

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

Throws:

java.io.IOException

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

writeDataBigInt

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

Write a signed big integer.

Note: variable length data type. Must be written to the data area.

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

writeDataBigDecimal

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

Write a big decimal number.

Note: variable length data type. Must be written to the data area.

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

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

writeInlineStringUTF8

public static void writeInlineStringUTF8(com.cinnober.msgcodec.io.ByteSink out,
                                         java.lang.String value,
                                         int maxLength)
                                  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

maxLength - the maximum string length in bytes, in the range [1, 255].

Throws:

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

java.lang.NullPointerException - if value is null

writeInlineStringUTF8Null

public static void writeInlineStringUTF8Null(com.cinnober.msgcodec.io.ByteSink out,
                                             java.lang.String value,
                                             int maxLength)
                                      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

maxLength - the maximum string length in bytes, in the range [1, 255].

Throws:

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

writeDataStringUTF8

public static void writeDataStringUTF8(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

writeInlineBinary

public static void writeInlineBinary(com.cinnober.msgcodec.io.ByteSink out,
                                     byte[] value,
                                     int maxLength)
                              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

maxLength - the maximum data length in bytes, in the range [1, 255].

Throws:

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

java.lang.NullPointerException - if value is null

writeInlineBinaryNull

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

Write nullable binary data.

Parameters:

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

value - the value to be written

maxLength - the maximum data length in bytes, in the range [1, 255].

Throws:

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

writeDataBinary

public static void writeDataBinary(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