BlinkInputStream (msgcodec-blink 2.3.0 API)

java.lang.Object
- java.io.InputStream
- - com.cinnober.msgcodec.util.LimitInputStream
  - - com.cinnober.msgcodec.blink.BlinkInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public class BlinkInputStream
extends com.cinnober.msgcodec.util.LimitInputStream
```
An input stream which lets an application read primitive Blink data types.

See Also:

BlinkOutputStream

Field Summary
- Fields inherited from class com.cinnober.msgcodec.util.LimitInputStream
  in

Constructor Summary

Constructors
Constructor and Description

BlinkInputStream(java.io.InputStream in)

Constructors
Constructor and Description
`BlinkInputStream(java.io.InputStream in)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`readBigDecimal()` Read a big decimal number.
`java.math.BigDecimal`	`readBigDecimalNull()` Read a nullable big decimal number.
`java.math.BigInteger`	`readBigInt()` Read a signed big integer.
`java.math.BigInteger`	`readBigIntNull()` Read a nullable signed big integer.
`byte[]`	`readBinary()` Read a binary value.
`byte[]`	`readBinary(int maxLength)` Read a binary value.
`byte[]`	`readBinaryNull()` Read a nullable binary value.
`byte[]`	`readBinaryNull(int maxLength)` Read a nullable binary value.
`boolean`	`readBoolean()` Read a boolean value.
`java.lang.Boolean`	`readBooleanNull()` Read a nullable boolean value.
`java.math.BigDecimal`	`readDecimal()` Read a decimal number.
`java.math.BigDecimal`	`readDecimalNull()` Read a nullable decimal number.
`float`	`readFloat32()` Read a 32-bit floating point number.
`java.lang.Float`	`readFloat32Null()` Read a nullable 32-bit floating point number.
`double`	`readFloat64()` Read a 64-bit floating point number.
`java.lang.Double`	`readFloat64Null()` Read a nullable 64-bit floating point number.
`short`	`readInt16()` Read a signed 16-bit integer.
`java.lang.Short`	`readInt16Null()` Read a nullable signed 16-bit integer.
`int`	`readInt32()` Read a signed 32-bit integer.
`java.lang.Integer`	`readInt32Null()` Read a nullable signed 32-bit integer.
`long`	`readInt64()` Read a signed 64-bit integer.
`java.lang.Long`	`readInt64Null()` Read a nullable signed 64-bit integer.
`byte`	`readInt8()` Read a signed 8-bit integer.
`java.lang.Byte`	`readInt8Null()` Read a nullable signed 8-bit integer.
`java.math.BigInteger`	`readSignedBigVLC()` Read a nullable unsigned big variable-length code value.
`java.math.BigInteger`	`readSignedBigVLCNull()` Read a nullable unsigned big variable-length code value.
`long`	`readSignedVLC()` Read a signed variable-length code value.
`java.lang.Long`	`readSignedVLCNull()` Read a nullable signed variable-length code value.
`java.lang.String`	`readStringUTF8()` Read a unicode string.
`java.lang.String`	`readStringUTF8(int maxLength)` Read a unicode string.
`java.lang.String`	`readStringUTF8Null()` Read a nullable unicode string.
`java.lang.String`	`readStringUTF8Null(int maxLength)` Read a nullable unicode string.
`short`	`readUInt16()` Read an unsigned 16-bit integer.
`java.lang.Short`	`readUInt16Null()` Read a nullable unsigned 16-bit integer.
`int`	`readUInt32()` Read an unsigned 32-bit integer.
`java.lang.Integer`	`readUInt32Null()` Read a nullable unsigned 32-bit integer.
`long`	`readUInt64()` Read an unsigned 64-bit integer.
`java.lang.Long`	`readUInt64Null()` Read a nullable unsigned 64-bit integer.
`byte`	`readUInt8()` Read an unsigned 8-bit integer.
`java.lang.Byte`	`readUInt8Null()` Read a nullable unsigned 8-bit integer.
`long`	`readUnsignedVLC()` Read a signed variable-length code value.
`java.lang.Long`	`readUnsignedVLCNull()` Read a nullable unsigned variable-length code value.
`void`	`setMaxBinarySize(int maxBinarySize)` The maximum size of binary data that is accepted.

Methods inherited from class com.cinnober.msgcodec.util.LimitInputStream
limit, limit, read, read, read, skip

Methods inherited from class java.io.InputStream
available, close, mark, markSupported, reset

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

- Constructor Detail
  - BlinkInputStream
```
public BlinkInputStream(java.io.InputStream in)
```
- Method Detail
  - setMaxBinarySize
```
public void setMaxBinarySize(int maxBinarySize)
```
    The maximum size of binary data that is accepted. This limit exists as a safe guard to avoid OutOfMemoryError in case of malformed input.
    Default value is 10 MB (10 048 576 bytes)
    
    Parameters:
    
    maxBinarySize - the limit in bytes, or -1 for no limit.
  - readInt8
```
public byte readInt8()
              throws java.io.IOException
```
    Read a signed 8-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readInt16
```
public short readInt16()
                throws java.io.IOException
```
    Read a signed 16-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readInt32
```
public int readInt32()
              throws java.io.IOException
```
    Read a signed 32-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readInt64
```
public long readInt64()
               throws java.io.IOException
```
    Read a signed 64-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt8
```
public byte readUInt8()
               throws java.io.IOException
```
    Read an unsigned 8-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt16
```
public short readUInt16()
                 throws java.io.IOException
```
    Read an unsigned 16-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt32
```
public int readUInt32()
               throws java.io.IOException
```
    Read an unsigned 32-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt64
```
public long readUInt64()
                throws java.io.IOException
```
    Read an unsigned 64-bit integer.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readInt8Null
```
public java.lang.Byte readInt8Null()
                            throws java.io.IOException
```
    Read a nullable signed 8-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readInt16Null
```
public java.lang.Short readInt16Null()
                              throws java.io.IOException
```
    Read a nullable signed 16-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readInt32Null
```
public java.lang.Integer readInt32Null()
                                throws java.io.IOException
```
    Read a nullable signed 32-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readInt64Null
```
public java.lang.Long readInt64Null()
                             throws java.io.IOException
```
    Read a nullable signed 64-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt8Null
```
public java.lang.Byte readUInt8Null()
                             throws java.io.IOException
```
    Read a nullable unsigned 8-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt16Null
```
public java.lang.Short readUInt16Null()
                               throws java.io.IOException
```
    Read a nullable unsigned 16-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt32Null
```
public java.lang.Integer readUInt32Null()
                                 throws java.io.IOException
```
    Read a nullable unsigned 32-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUInt64Null
```
public java.lang.Long readUInt64Null()
                              throws java.io.IOException
```
    Read a nullable unsigned 64-bit integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBigInt
```
public java.math.BigInteger readBigInt()
                                throws java.io.IOException
```
    Read a signed big integer.
    
    Returns:
    
    the value, not null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBigIntNull
```
public java.math.BigInteger readBigIntNull()
                                    throws java.io.IOException
```
    Read a nullable signed big integer.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readFloat32
```
public float readFloat32()
                  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.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
    
    See Also:
    
    readFloat64()
  - readFloat32Null
```
public java.lang.Float readFloat32Null()
                                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.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
    
    See Also:
    
    readFloat64()
  - readFloat64
```
public double readFloat64()
                   throws java.io.IOException
```
    Read a 64-bit floating point number.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readFloat64Null
```
public java.lang.Double readFloat64Null()
                                 throws java.io.IOException
```
    Read a nullable 64-bit floating point number.
    
    Returns:
    
    the value, or null
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readDecimal
```
public java.math.BigDecimal readDecimal()
                                 throws java.io.IOException
```
    Read a decimal number.
    
    Returns:
    
    the value, not null
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readDecimalNull
```
public java.math.BigDecimal readDecimalNull()
                                     throws java.io.IOException
```
    Read a nullable decimal number.
    
    Returns:
    
    the value, or null
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBigDecimal
```
public java.math.BigDecimal readBigDecimal()
                                    throws java.io.IOException
```
    Read a big decimal number.
    
    Returns:
    
    the value, not null
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBigDecimalNull
```
public java.math.BigDecimal readBigDecimalNull()
                                        throws java.io.IOException
```
    Read a nullable big decimal number.
    
    Returns:
    
    the value, or null
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBoolean
```
public boolean readBoolean()
                    throws java.io.IOException
```
    Read a boolean value.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBooleanNull
```
public java.lang.Boolean readBooleanNull()
                                  throws java.io.IOException
```
    Read a nullable boolean value.
    
    Returns:
    
    the value, or null
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readStringUTF8
```
public java.lang.String readStringUTF8()
                                throws java.io.IOException
```
    Read a unicode string.
    
    Returns:
    
    the value, not null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readStringUTF8Null
```
public java.lang.String readStringUTF8Null()
                                    throws java.io.IOException
```
    Read a nullable unicode string.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readStringUTF8
```
public java.lang.String readStringUTF8(int maxLength)
                                throws java.io.IOException
```
    Read a unicode string.
    
    Parameters:
    
    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 value could not be parsed, or if the underlying stream throws an exception.
  - readStringUTF8Null
```
public java.lang.String readStringUTF8Null(int maxLength)
                                    throws java.io.IOException
```
    Read a nullable unicode string.
    
    Parameters:
    
    maxLength - the maximum string length (characters) that is allowed, or -1 for no limit.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBinary
```
public byte[] readBinary()
                  throws java.io.IOException
```
    Read a binary value.
    
    Returns:
    
    the value, not null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBinaryNull
```
public byte[] readBinaryNull()
                      throws java.io.IOException
```
    Read a nullable binary value.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readBinary
```
public byte[] readBinary(int maxLength)
                  throws java.io.IOException
```
    Read a binary value.
    
    Parameters:
    
    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 value could not be parsed, or if the underlying stream throws an exception.
  - readBinaryNull
```
public byte[] readBinaryNull(int maxLength)
                      throws java.io.IOException
```
    Read a nullable binary value.
    
    Parameters:
    
    maxLength - the maximum binary length (bytes) that is allowed, or -1 for no limit.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readSignedVLCNull
```
public java.lang.Long readSignedVLCNull()
                                 throws java.io.IOException
```
    Read a nullable signed variable-length code value.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readSignedVLC
```
public long readSignedVLC()
                   throws java.io.IOException
```
    Read a signed variable-length code value.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readSignedBigVLC
```
public java.math.BigInteger readSignedBigVLC()
                                      throws java.io.IOException
```
    Read a nullable unsigned big variable-length code value.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readSignedBigVLCNull
```
public java.math.BigInteger readSignedBigVLCNull()
                                          throws java.io.IOException
```
    Read a nullable unsigned big variable-length code value.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUnsignedVLCNull
```
public java.lang.Long readUnsignedVLCNull()
                                   throws java.io.IOException
```
    Read a nullable unsigned variable-length code value.
    
    Returns:
    
    the value, or null.
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.
  - readUnsignedVLC
```
public long readUnsignedVLC()
                     throws java.io.IOException
```
    Read a signed variable-length code value.
    
    Returns:
    
    the value
    
    Throws:
    
    java.io.IOException - if the value could not be parsed, or if the underlying stream throws an exception.

Class BlinkInputStream

Field Summary

Fields inherited from class com.cinnober.msgcodec.util.LimitInputStream

Constructor Summary

Method Summary

Methods inherited from class com.cinnober.msgcodec.util.LimitInputStream

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Constructor Detail

BlinkInputStream

Method Detail

setMaxBinarySize

readInt8

readInt16

readInt32

readInt64

readUInt8

readUInt16

readUInt32

readUInt64

readInt8Null

readInt16Null

readInt32Null

readInt64Null

readUInt8Null

readUInt16Null

readUInt32Null

readUInt64Null

readBigInt

readBigIntNull

readFloat32

readFloat32Null

readFloat64

readFloat64Null

readDecimal

readDecimalNull

readBigDecimal

readBigDecimalNull

readBoolean

readBooleanNull

readStringUTF8

readStringUTF8Null

readStringUTF8

readStringUTF8Null

readBinary

readBinaryNull

readBinary

readBinaryNull

readSignedVLCNull

readSignedVLC

readSignedBigVLC

readSignedBigVLCNull

readUnsignedVLCNull

readUnsignedVLC