com.cinnober.msgcodec.blink

Class NativeBlinkInput

java.lang.Object

com.cinnober.msgcodec.blink.NativeBlinkInput

public class NativeBlinkInput
extends java.lang.Object

Methods for reading primitive Native Blink data types.

Read methods for variable size data types come in two flavors: readInlineXxx and readDataXxx for inline and data area respectively.

See Also:

BlinkOutput

Method Summary

Modifier and Type	Method and Description
static boolean	readBoolean(com.cinnober.msgcodec.io.ByteSource in) Read a boolean value.
static java.lang.Boolean	readBooleanNull(com.cinnober.msgcodec.io.ByteSource in) Read a nullable boolean value.
static java.math.BigDecimal	readDataBigDecimal(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read a big decimal number.
static java.math.BigInteger	readDataBigInt(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read a signed big integer.
static byte[]	readDataBinary(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read binary data.
static java.lang.String	readDataStringUTF8(com.cinnober.msgcodec.io.ByteSource in) Read a unicode string.
static java.lang.String	readDataStringUTF8(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read a unicode string.
static java.math.BigDecimal	readDecimal(com.cinnober.msgcodec.io.ByteSource in) Read a decimal number.
static java.math.BigDecimal	readDecimalNull(com.cinnober.msgcodec.io.ByteSource in) Read a nullable decimal number.
static float	readFloat32(com.cinnober.msgcodec.io.ByteSource in) Read a 32-bit floating point number.
static java.lang.Float	readFloat32Null(com.cinnober.msgcodec.io.ByteSource in) Read a nullable 32-bit floating point number.
static double	readFloat64(com.cinnober.msgcodec.io.ByteSource in) Read a 64-bit floating point number.
static java.lang.Double	readFloat64Null(com.cinnober.msgcodec.io.ByteSource in) Read a nullable 64-bit floating point number.
static byte[]	readInlineBinary(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read a binary value.
static byte[]	readInlineBinaryNull(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read a nullable binary value.
static java.lang.String	readInlineStringUTF8(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read a unicode string.
static java.lang.String	readInlineStringUTF8Null(com.cinnober.msgcodec.io.ByteSource in, int maxLength) Read a nullable unicode string.
static short	readInt16(com.cinnober.msgcodec.io.ByteSource in) Read a signed 16-bit integer.
static java.lang.Short	readInt16Null(com.cinnober.msgcodec.io.ByteSource in) Read a nullable signed 16-bit integer.
static int	readInt32(com.cinnober.msgcodec.io.ByteSource in) Read a signed 32-bit integer.
static java.lang.Integer	readInt32Null(com.cinnober.msgcodec.io.ByteSource in) Read a nullable signed 32-bit integer.
static long	readInt64(com.cinnober.msgcodec.io.ByteSource in) Read a signed 64-bit integer.
static java.lang.Long	readInt64Null(com.cinnober.msgcodec.io.ByteSource in) Read a nullable signed 64-bit integer.
static byte	readInt8(com.cinnober.msgcodec.io.ByteSource in) Read a signed 8-bit integer.
static java.lang.Byte	readInt8Null(com.cinnober.msgcodec.io.ByteSource in) Read a nullable signed 8-bit integer.
static short	readUInt16(com.cinnober.msgcodec.io.ByteSource in)
static java.lang.Short	readUInt16Null(com.cinnober.msgcodec.io.ByteSource in)
static int	readUInt32(com.cinnober.msgcodec.io.ByteSource in)
static java.lang.Integer	readUInt32Null(com.cinnober.msgcodec.io.ByteSource in)
static long	readUInt64(com.cinnober.msgcodec.io.ByteSource in)
static java.lang.Long	readUInt64Null(com.cinnober.msgcodec.io.ByteSource in)
static byte	readUInt8(com.cinnober.msgcodec.io.ByteSource in)
static java.lang.Byte	readUInt8Null(com.cinnober.msgcodec.io.ByteSource in)

Methods inherited from class java.lang.Object

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

Method Detail

readInt8

public static byte readInt8(com.cinnober.msgcodec.io.ByteSource in)
                     throws java.io.IOException

Read a signed 8-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInt16

public static short readInt16(com.cinnober.msgcodec.io.ByteSource in)
                       throws java.io.IOException

Read a signed 16-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInt32

public static int readInt32(com.cinnober.msgcodec.io.ByteSource in)
                     throws java.io.IOException

Read a signed 32-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInt64

public static long readInt64(com.cinnober.msgcodec.io.ByteSource in)
                      throws java.io.IOException

Read a signed 64-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInt8Null

public static java.lang.Byte readInt8Null(com.cinnober.msgcodec.io.ByteSource in)
                                   throws java.io.IOException

Read a nullable signed 8-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInt16Null

public static java.lang.Short readInt16Null(com.cinnober.msgcodec.io.ByteSource in)
                                     throws java.io.IOException

Read a nullable signed 16-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInt32Null

public static java.lang.Integer readInt32Null(com.cinnober.msgcodec.io.ByteSource in)
                                       throws java.io.IOException

Read a nullable signed 32-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInt64Null

public static java.lang.Long readInt64Null(com.cinnober.msgcodec.io.ByteSource in)
                                    throws java.io.IOException

Read a nullable signed 64-bit integer.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readUInt8

public static byte readUInt8(com.cinnober.msgcodec.io.ByteSource in)
                      throws java.io.IOException

Throws:

java.io.IOException

readUInt8Null

public static java.lang.Byte readUInt8Null(com.cinnober.msgcodec.io.ByteSource in)
                                    throws java.io.IOException

Throws:

java.io.IOException

readUInt16

public static short readUInt16(com.cinnober.msgcodec.io.ByteSource in)
                        throws java.io.IOException

Throws:

java.io.IOException

readUInt16Null

public static java.lang.Short readUInt16Null(com.cinnober.msgcodec.io.ByteSource in)
                                      throws java.io.IOException

Throws:

java.io.IOException

readUInt32

public static int readUInt32(com.cinnober.msgcodec.io.ByteSource in)
                      throws java.io.IOException

Throws:

java.io.IOException

readUInt32Null

public static java.lang.Integer readUInt32Null(com.cinnober.msgcodec.io.ByteSource in)
                                        throws java.io.IOException

Throws:

java.io.IOException

readUInt64

public static long readUInt64(com.cinnober.msgcodec.io.ByteSource in)
                       throws java.io.IOException

Throws:

java.io.IOException

readUInt64Null

public static java.lang.Long readUInt64Null(com.cinnober.msgcodec.io.ByteSource in)
                                     throws java.io.IOException

Throws:

java.io.IOException

readDataBigInt

public static java.math.BigInteger readDataBigInt(com.cinnober.msgcodec.io.ByteSource in,
                                                  int maxLength)
                                           throws java.io.IOException

Read a signed big integer.

Parameters:

in - the input stream to read from, not null.

maxLength - the maximum bigint length (bytes) that is allowed, or -1 for no limit.

Returns:

the value, not null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readFloat32

public static float readFloat32(com.cinnober.msgcodec.io.ByteSource in)
                         throws java.io.IOException

Read a 32-bit floating point number.

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

Parameters:

in - the input stream to read from, not null.

Returns:

the value

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

See Also:

readFloat64(ByteSource)

readFloat32Null

public static java.lang.Float readFloat32Null(com.cinnober.msgcodec.io.ByteSource in)
                                       throws java.io.IOException

Read a nullable 32-bit floating point number.

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

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

See Also:

readFloat64(ByteSource)

readFloat64

public static double readFloat64(com.cinnober.msgcodec.io.ByteSource in)
                          throws java.io.IOException

Read a 64-bit floating point number.

Parameters:

in - the input stream to read from, not null.

Returns:

the value

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readFloat64Null

public static java.lang.Double readFloat64Null(com.cinnober.msgcodec.io.ByteSource in)
                                        throws java.io.IOException

Read a nullable 64-bit floating point number.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readDecimal

public static java.math.BigDecimal readDecimal(com.cinnober.msgcodec.io.ByteSource in)
                                        throws java.io.IOException

Read a decimal number.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, not null

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readDecimalNull

public static java.math.BigDecimal readDecimalNull(com.cinnober.msgcodec.io.ByteSource in)
                                            throws java.io.IOException

Read a nullable decimal number.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readDataBigDecimal

public static java.math.BigDecimal readDataBigDecimal(com.cinnober.msgcodec.io.ByteSource in,
                                                      int maxLength)
                                               throws java.io.IOException

Read a big decimal number.

Parameters:

in - the input stream to read from, not null.

maxLength - the maximum data length (bytes) that is allowed for the mantissa, or -1 for no limit.

Returns:

the value, not null

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readBoolean

public static boolean readBoolean(com.cinnober.msgcodec.io.ByteSource in)
                           throws java.io.IOException

Read a boolean value.

Parameters:

in - the input stream to read from, not null.

Returns:

the value

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readBooleanNull

public static java.lang.Boolean readBooleanNull(com.cinnober.msgcodec.io.ByteSource in)
                                         throws java.io.IOException

Read a nullable boolean value.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, or null

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInlineStringUTF8

public static java.lang.String readInlineStringUTF8(com.cinnober.msgcodec.io.ByteSource in,
                                                    int maxLength)
                                             throws java.io.IOException

Read a unicode string.

Parameters:

in - the input stream to read from, not null.

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

Returns:

the value, not null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInlineStringUTF8Null

public static java.lang.String readInlineStringUTF8Null(com.cinnober.msgcodec.io.ByteSource in,
                                                        int maxLength)
                                                 throws java.io.IOException

Read a nullable unicode string.

Parameters:

in - the input stream to read from, not null.

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

Returns:

the value, or null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readDataStringUTF8

public static java.lang.String readDataStringUTF8(com.cinnober.msgcodec.io.ByteSource in)
                                           throws java.io.IOException

Read a unicode string.

Parameters:

in - the input stream to read from, not null.

Returns:

the value, not null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readDataStringUTF8

public static java.lang.String readDataStringUTF8(com.cinnober.msgcodec.io.ByteSource in,
                                                  int maxLength)
                                           throws java.io.IOException

Read a unicode string.

Parameters:

in - the input stream to read from, not null.

maxLength - the maximum string length (bytes) that is allowed, or -1 for no limit.

Returns:

the value, not null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInlineBinary

public static byte[] readInlineBinary(com.cinnober.msgcodec.io.ByteSource in,
                                      int maxLength)
                               throws java.io.IOException

Read a binary value.

Parameters:

in - the input stream to read from, not null.

maxLength - the maximum binary length (bytes), in the range [1, 255].

Returns:

the value, not null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readInlineBinaryNull

public static byte[] readInlineBinaryNull(com.cinnober.msgcodec.io.ByteSource in,
                                          int maxLength)
                                   throws java.io.IOException

Read a nullable binary value.

Parameters:

in - the input stream to read from, not null.

maxLength - the maximum binary length (bytes), in the range [1, 255].

Returns:

the value, or null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.

readDataBinary

public static byte[] readDataBinary(com.cinnober.msgcodec.io.ByteSource in,
                                    int maxLength)
                             throws java.io.IOException

Read binary data.

Parameters:

in - the input stream to read from, not null.

maxLength - the maximum binary length (bytes) that is allowed, or -1 for no limit.

Returns:

the value, not null.

Throws:

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

com.cinnober.msgcodec.DecodeException - if the value could not be parsed.