com.cinnober.msgcodec.blink

Class BlinkOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.cinnober.msgcodec.blink.BlinkOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class BlinkOutputStream
extends java.io.FilterOutputStream

An output stream which lets an application write primitive Blink data types.

See Also:

BlinkInputStream

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
BlinkOutputStream(java.io.OutputStream out)

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	writeBigDecimal(java.math.BigDecimal value) Write a big decimal number.
void	writeBigDecimalNull(java.math.BigDecimal value) Write a nullable big decimal number.
void	writeBigInt(java.math.BigInteger value) Write a signed big integer.
void	writeBigIntNull(java.math.BigInteger value) Write a nullable signed big integer.
void	writeBinary(byte[] value) Write binary data.
void	writeBinaryNull(byte[] value) Write nullable binary data.
void	writeBoolean(boolean value) Write a boolean.
void	writeBooleanNull(java.lang.Boolean value) Write a nullable boolean.
void	writeDecimal(java.math.BigDecimal value) Write a decimal number.
void	writeDecimalNull(java.math.BigDecimal value) Write a nullable decimal number.
void	writeFloat32(float value) Write a 32-bit floating point number.
void	writeFloat32Null(java.lang.Float value) Write a nullable 32-bit floating point number.
void	writeFloat64(double value) Write a 64-bit floating point number.
void	writeFloat64Null(java.lang.Double value) Write a nullable 64-bit floating point number.
void	writeInt16(short value) Write a signed 16-bit integer.
void	writeInt16Null(java.lang.Short value) Write a nullable signed 16-bit integer.
void	writeInt32(int value) Write a signed 32-bit integer.
void	writeInt32Null(java.lang.Integer value) Write a nullable signed 32-bit integer.
void	writeInt64(long value) Write a signed 64-bit integer.
void	writeInt64Null(java.lang.Long value) Write a nullable signed 64-bit integer.
void	writeInt8(byte value) Write a signed 8-bit integer.
void	writeInt8Null(java.lang.Byte value) Write a nullable signed 8-bit integer.
void	writeNull() Write the null (0xc0) value.
void	writeSignedBigVLC(java.math.BigInteger value) Write a signed big variable-length code value.
void	writeSignedVLC(long value) Write a signed variable-length code value.
void	writeStringUTF8(java.lang.String value) Write a unicode string.
void	writeStringUTF8Null(java.lang.String value) Write a nullable unicode string.
void	writeUInt16(short value) Write an unsigned 16-bit integer.
void	writeUInt16Null(java.lang.Short value) Write a nullable unsigned 16-bit integer.
void	writeUInt32(int value) Write an unsigned 32-bit integer.
void	writeUInt32Null(java.lang.Integer value) Write a nullable unsigned 32-bit integer.
void	writeUInt64(long value) Write an unsigned 64-bit integer.
void	writeUInt64Null(java.lang.Long value) Write a nullable unsigned 64-bit integer.
void	writeUInt8(byte value) Write an unsigned 8-bit integer.
void	writeUInt8Null(java.lang.Byte value) Write a nullable unsigned 8-bit integer.
void	writeUnsignedVLC(long value) Write an unsigned variable-length code value.

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BlinkOutputStream

public BlinkOutputStream(java.io.OutputStream out)

Method Detail

writeNull

public void writeNull()
               throws java.io.IOException

Write the null (0xc0) value.

Throws:

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

writeInt8

public void writeInt8(byte value)
               throws java.io.IOException

Write a signed 8-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeInt16

public void writeInt16(short value)
                throws java.io.IOException

Write a signed 16-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeInt32

public void writeInt32(int value)
                throws java.io.IOException

Write a signed 32-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeInt64

public void writeInt64(long value)
                throws java.io.IOException

Write a signed 64-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt8

public void writeUInt8(byte value)
                throws java.io.IOException

Write an unsigned 8-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt16

public void writeUInt16(short value)
                 throws java.io.IOException

Write an unsigned 16-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt32

public void writeUInt32(int value)
                 throws java.io.IOException

Write an unsigned 32-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt64

public void writeUInt64(long value)
                 throws java.io.IOException

Write an unsigned 64-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeInt8Null

public void writeInt8Null(java.lang.Byte value)
                   throws java.io.IOException

Write a nullable signed 8-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeInt16Null

public void writeInt16Null(java.lang.Short value)
                    throws java.io.IOException

Write a nullable signed 16-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeInt32Null

public void writeInt32Null(java.lang.Integer value)
                    throws java.io.IOException

Write a nullable signed 32-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeInt64Null

public void writeInt64Null(java.lang.Long value)
                    throws java.io.IOException

Write a nullable signed 64-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt8Null

public void writeUInt8Null(java.lang.Byte value)
                    throws java.io.IOException

Write a nullable unsigned 8-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt16Null

public void writeUInt16Null(java.lang.Short value)
                     throws java.io.IOException

Write a nullable unsigned 16-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt32Null

public void writeUInt32Null(java.lang.Integer value)
                     throws java.io.IOException

Write a nullable unsigned 32-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeUInt64Null

public void writeUInt64Null(java.lang.Long value)
                     throws java.io.IOException

Write a nullable unsigned 64-bit integer.

Parameters:

value - the value to be written

Throws:

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

writeBigIntNull

public void writeBigIntNull(java.math.BigInteger value)
                     throws java.io.IOException

Write a nullable signed big integer.

Parameters:

value - the value to be written

Throws:

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

writeBigInt

public void writeBigInt(java.math.BigInteger value)
                 throws java.io.IOException

Write a signed big integer.

Parameters:

value - the value to be written, not null

Throws:

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

writeFloat32

public void writeFloat32(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:

value - the value to be written

Throws:

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

See Also:

writeFloat64(double)

writeFloat32Null

public void writeFloat32Null(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:

value - the value to be written

Throws:

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

See Also:

writeFloat64Null(Double)

writeFloat64

public void writeFloat64(double value)
                  throws java.io.IOException

Write a 64-bit floating point number.

Parameters:

value - the value to be written

Throws:

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

writeFloat64Null

public void writeFloat64Null(java.lang.Double value)
                      throws java.io.IOException

Write a nullable 64-bit floating point number.

Parameters:

value - the value to be written

Throws:

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

writeDecimal

public void writeDecimal(java.math.BigDecimal value)
                  throws java.io.IOException,
                         java.lang.NullPointerException

Write a decimal number.

Parameters:

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 void writeDecimalNull(java.math.BigDecimal value)
                      throws java.io.IOException

Write a nullable decimal number.

Parameters:

value - the value to be written

Throws:

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

writeBigDecimal

public void writeBigDecimal(java.math.BigDecimal value)
                     throws java.io.IOException,
                            java.lang.NullPointerException

Write a big decimal number.

Parameters:

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 void writeBigDecimalNull(java.math.BigDecimal value)
                         throws java.io.IOException

Write a nullable big decimal number.

Parameters:

value - the value to be written

Throws:

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

writeBoolean

public void writeBoolean(boolean value)
                  throws java.io.IOException

Write a boolean.

Parameters:

value - the value to be written

Throws:

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

writeBooleanNull

public void writeBooleanNull(java.lang.Boolean value)
                      throws java.io.IOException

Write a nullable boolean.

Parameters:

value - the value to be written

Throws:

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

writeStringUTF8

public void writeStringUTF8(java.lang.String value)
                     throws java.io.IOException

Write a unicode string.

Parameters:

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 void writeStringUTF8Null(java.lang.String value)
                         throws java.io.IOException

Write a nullable unicode string.

Parameters:

value - the value to be written

Throws:

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

writeBinary

public void writeBinary(byte[] value)
                 throws java.io.IOException

Write binary data.

Parameters:

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 void writeBinaryNull(byte[] value)
                     throws java.io.IOException

Write nullable binary data.

Parameters:

value - the value to be written

Throws:

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

writeSignedBigVLC

public void writeSignedBigVLC(java.math.BigInteger value)
                       throws java.io.IOException

Write a signed big variable-length code value.

Parameters:

value - the value to be written, not null

Throws:

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

writeSignedVLC

public void writeSignedVLC(long value)
                    throws java.io.IOException

Write a signed variable-length code value.

Parameters:

value - the value to be written

Throws:

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

writeUnsignedVLC

public void writeUnsignedVLC(long value)
                      throws java.io.IOException

Write an unsigned variable-length code value.

Parameters:

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].

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].