CompactObjectInput (MyTISM API Documentation)

java.lang.Object
- de.ipcon.db.io.CompactObjectInput

All Implemented Interfaces:

SidebandHandlerI, BLOBInputI, DigestingBLOBInputI, ObjectDataInputI, SecureObjectInputI, java.io.Closeable, java.io.DataInput, java.io.ObjectInput, java.lang.AutoCloseable

Direct Known Subclasses:

SidebandHandlingCompactObjectInput
```
public class CompactObjectInput
extends java.lang.Object
implements java.io.Closeable, java.io.ObjectInput, ObjectDataInputI, DigestingBLOBInputI, SecureObjectInputI, SidebandHandlerI
```

Constructor Summary

Constructors
Constructor and Description
`CompactObjectInput(java.io.InputStream _in)` Creates a CompactObjectInput that reads from the specified DataInput.
`CompactObjectInput(java.io.InputStream _in, SchemaI schema)`
`CompactObjectInput(java.io.InputStream _in, SchemaI schema, java.util.function.Function replaceBoAfterRead)`
`CompactObjectInput(java.io.InputStream _in, SchemaI schema, java.util.function.Function replaceBoAfterRead, SidebandHandlerI _sidebandHandler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`_readBLOB(byte[] buffer, int off, int len)`
`int`	`available()` Returns the number of bytes that can be read without blocking.
`void`	`close()` Closes this CompactObjectInput and releases any system resources associated with it.
`void`	`handleSideband()`
`int`	`read()` Reads a byte of data.
`int`	`read(byte[] b)` Reads into an array of bytes.
`int`	`read(byte[] b, int off, int len)` Reads into an array of bytes.
`java.math.BigDecimal`	`readBigDecimal()` Reads a BigDecimal object from our DataInput.
`byte[]`	`readBLOB()` Reads a byte-array from our DataInput and returns it.
`int`	`readBLOB(byte[] buffer, int off, int len)` Reads a chunk of $size bytes into the given byte array $buffer, starting at offset $off.
`int`	`readBLOB(java.io.DataOutput out)` Reads bytes from our DataInput and writes them to the passed DataOutput os.
`int`	`readBLOB(java.io.DataOutput out, java.security.MessageDigest digester)`
`int`	`readBLOB(java.io.OutputStream out)` Reads bytes from our DataInput and writes them to the passed OutputStream os.
`int`	`readBLOB(java.io.OutputStream out, java.security.MessageDigest digester)`
`boolean`	`readBoolean()` Reads one input byte and returns true if that byte is nonzero, false if that byte is zero.
`java.lang.Boolean`	`readBooleanObject()` Reads a Boolean object from our DataInput.
`byte`	`readByte()` Reads and returns one input byte.
`java.lang.Byte`	`readByteObject()` Reads a Byte object from our DataInput.
`char`	`readChar()` Reads two input bytes and returns a char value.
`java.util.Date`	`readDate()` Reads a Date from our DataInput.
`double`	`readDouble()` Reads eight input bytes and returns a double value.
`java.lang.Double`	`readDoubleObject()` Reads a Double object from our DataInput.
`float`	`readFloat()` Reads four input bytes and returns a float value.
`java.lang.Float`	`readFloatObject()` Reads a Float object from our DataInput.
`void`	`readFully(byte[] b)` Reads some bytes from our DataInput and stores them into the buffer array b.
`void`	`readFully(byte[] b, int off, int len)` Reads len bytes our DataInput.
`int`	`readInt()` Reads four input bytes and returns an int value.
`int[]`	`readIntegerArray()` Reads an int array from our DataInput.
`java.lang.Integer`	`readIntegerObject()` Reads a Integer object from our DataInput.
`java.lang.String`	`readLine()` Reads the next line of text from our DataInput.
`long`	`readLong()` Reads eight input bytes and returns a long value.
`long[]`	`readLongArray()` Reads a long array from our DataInput.
`java.lang.Long`	`readLongObject()` Reads a Long object from our DataInput.
`java.lang.Object`	`readObject()` Read and return an object.
`java.lang.Object`	`readObject(java.lang.Class[] expectedClasses)` Reads an Object from our DataInput, expecting an object of one of the given classes.
`java.lang.Object[]`	`readObjectArray()` Reads an Object array from our DataInput.
`short`	`readShort()` Reads two input bytes and returns a short value.
`java.lang.Short`	`readShortObject()` Reads a Short object from our DataInput.
`java.lang.String`	`readString()` Reads a UTF-8 string from our DataInput.
`java.lang.String[]`	`readStringArray()` Reads a String array from our DataInput.
`int`	`readUnsignedByte()` Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.
`int`	`readUnsignedShort()` Reads two input bytes and returns an int value in the range 0 through 65535.
`java.lang.String`	`readUTF()` Reads in a string that has been encoded using a modified UTF-8 format.
`CompactObjectInput`	`setBlocksize(int b)` Sets the blocksize for data-transfer to the passed value in bytes.
`void`	`setObjectTransferHandler(ObjectTransferHandlerI _objectTransferHandler)` Sets the ObjectTransferHandlerI for this class.
`void`	`setSidebandHandler(SidebandHandlerI sbh)` Sets the SidebandHandlerI for this class.
`long`	`skip(long n)` Skips n bytes of input.
`int`	`skipBytes(int n)` Makes an attempt to skip over n bytes of data from our DataInput, discarding the skipped bytes.

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

- Constructor Detail
  - CompactObjectInput
```
public CompactObjectInput(java.io.InputStream _in)
```
    Creates a CompactObjectInput that reads from the specified DataInput.
  - CompactObjectInput
```
public CompactObjectInput(java.io.InputStream _in,
                          SchemaI schema)
```
  - CompactObjectInput
```
public CompactObjectInput(java.io.InputStream _in,
                          SchemaI schema,
                          java.util.function.Function replaceBoAfterRead)
```
  - CompactObjectInput
```
public CompactObjectInput(java.io.InputStream _in,
                          SchemaI schema,
                          java.util.function.Function replaceBoAfterRead,
                          SidebandHandlerI _sidebandHandler)
```
- Method Detail
  - setBlocksize
```
public CompactObjectInput setBlocksize(int b)
```
    Sets the blocksize for data-transfer to the passed value in bytes.
  - setSidebandHandler
```
public void setSidebandHandler(SidebandHandlerI sbh)
```
    Sets the SidebandHandlerI for this class.
  - setObjectTransferHandler
```
public void setObjectTransferHandler(ObjectTransferHandlerI _objectTransferHandler)
```
    Sets the ObjectTransferHandlerI for this class.
  - handleSideband
```
public void handleSideband()
                    throws java.io.IOException
```
    Specified by:
    
    handleSideband in interface SidebandHandlerI
    
    Throws:
    
    java.io.IOException
  - close
```
public void close()
           throws java.io.IOException
```
    Closes this CompactObjectInput and releases any system resources associated with it.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.io.ObjectInput
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - readBoolean
```
public boolean readBoolean()
                    throws java.io.IOException
```
    Reads one input byte and returns true if that byte is nonzero, false if that byte is zero.
    
    Specified by:
    
    readBoolean in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readByte
```
public byte readByte()
              throws java.io.IOException
```
    Reads and returns one input byte.
    
    Specified by:
    
    readByte in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readChar
```
public char readChar()
              throws java.io.IOException
```
    Reads two input bytes and returns a char value.
    
    Specified by:
    
    readChar in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readDouble
```
public double readDouble()
                  throws java.io.IOException
```
    Reads eight input bytes and returns a double value.
    
    Specified by:
    
    readDouble in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readFloat
```
public float readFloat()
                throws java.io.IOException
```
    Reads four input bytes and returns a float value.
    
    Specified by:
    
    readFloat in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readFully
```
public void readFully(byte[] b)
```
    Reads some bytes from our DataInput and stores them into the buffer array b.
    
    Specified by:
    
    readFully in interface java.io.DataInput
  - readFully
```
public void readFully(byte[] b,
                      int off,
                      int len)
```
    Reads len bytes our DataInput.
    
    Specified by:
    
    readFully in interface java.io.DataInput
  - readLine
```
public java.lang.String readLine()
                          throws java.io.IOException
```
    Reads the next line of text from our DataInput.
    
    Specified by:
    
    readLine in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readLong
```
public long readLong()
              throws java.io.IOException
```
    Reads eight input bytes and returns a long value.
    
    Specified by:
    
    readLong in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readInt
```
public int readInt()
            throws java.io.IOException
```
    Reads four input bytes and returns an int value.
    
    Specified by:
    
    readInt in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readShort
```
public short readShort()
                throws java.io.IOException
```
    Reads two input bytes and returns a short value.
    
    Specified by:
    
    readShort in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readUnsignedByte
```
public int readUnsignedByte()
                     throws java.io.IOException
```
    Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.
    
    Specified by:
    
    readUnsignedByte in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readUnsignedShort
```
public int readUnsignedShort()
                      throws java.io.IOException
```
    Reads two input bytes and returns an int value in the range 0 through 65535.
    
    Specified by:
    
    readUnsignedShort in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - readUTF
```
public java.lang.String readUTF()
                         throws java.io.IOException
```
    Reads in a string that has been encoded using a modified UTF-8 format.
    
    Specified by:
    
    readUTF in interface java.io.DataInput
    
    Throws:
    
    java.io.IOException
  - skipBytes
```
public int skipBytes(int n)
```
    Makes an attempt to skip over n bytes of data from our DataInput, discarding the skipped bytes.
    
    Specified by:
    
    skipBytes in interface java.io.DataInput
  - readBooleanObject
```
public java.lang.Boolean readBooleanObject()
                                    throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Boolean object from our DataInput.
    
    Specified by:
    
    readBooleanObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readByteObject
```
public java.lang.Byte readByteObject()
                              throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Byte object from our DataInput.
    
    Specified by:
    
    readByteObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readDoubleObject
```
public java.lang.Double readDoubleObject()
                                  throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Double object from our DataInput.
    
    Specified by:
    
    readDoubleObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readFloatObject
```
public java.lang.Float readFloatObject()
                                throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Float object from our DataInput.
    
    Specified by:
    
    readFloatObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readIntegerObject
```
public java.lang.Integer readIntegerObject()
                                    throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Integer object from our DataInput.
    
    Specified by:
    
    readIntegerObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readLongObject
```
public java.lang.Long readLongObject()
                              throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Long object from our DataInput.
    
    Specified by:
    
    readLongObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readShortObject
```
public java.lang.Short readShortObject()
                                throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Short object from our DataInput.
    
    Specified by:
    
    readShortObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readBigDecimal
```
public java.math.BigDecimal readBigDecimal()
                                    throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a BigDecimal object from our DataInput.
    
    Specified by:
    
    readBigDecimal in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readString
```
public java.lang.String readString()
                            throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a UTF-8 string from our DataInput.
    
    Specified by:
    
    readString in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readDate
```
public java.util.Date readDate()
                        throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a Date from our DataInput.
    
    Specified by:
    
    readDate in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readStringArray
```
public java.lang.String[] readStringArray()
                                   throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a String array from our DataInput.
    
    Specified by:
    
    readStringArray in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readIntegerArray
```
public int[] readIntegerArray()
                       throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads an int array from our DataInput.
    
    Specified by:
    
    readIntegerArray in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readLongArray
```
public long[] readLongArray()
                     throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads a long array from our DataInput.
    
    Specified by:
    
    readLongArray in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readObjectArray
```
public java.lang.Object[] readObjectArray()
                                   throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads an Object array from our DataInput.
    
    Specified by:
    
    readObjectArray in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - readBLOB
```
public byte[] readBLOB()
                throws java.io.IOException
```
    Description copied from interface: BLOBInputI
    
    Reads a byte-array from our DataInput and returns it.
    
    Specified by:
    
    readBLOB in interface BLOBInputI
    
    Throws:
    
    java.io.IOException
  - readBLOB
```
public int readBLOB(byte[] buffer,
                    int off,
                    int len)
             throws java.io.IOException
```
    Reads a chunk of $size bytes into the given byte array $buffer, starting at offset $off.
    
    Returns:
    
    number of bytes read, must be same as given size
    
    Throws:
    
    IOException - if the number of bytes written into correponding CompactObjectOutput != len
  - _readBLOB
```
public byte[] _readBLOB(byte[] buffer,
                        int off,
                        int len)
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - readBLOB
```
public int readBLOB(java.io.DataOutput out)
             throws java.io.IOException
```
    Description copied from interface: BLOBInputI
    
    Reads bytes from our DataInput and writes them to the passed DataOutput os.
    
    Specified by:
    
    readBLOB in interface BLOBInputI
    
    Throws:
    
    java.io.IOException
  - readBLOB
```
public int readBLOB(java.io.DataOutput out,
                    java.security.MessageDigest digester)
             throws java.io.IOException
```
    Specified by:
    
    readBLOB in interface DigestingBLOBInputI
    
    Throws:
    
    java.io.IOException
  - readBLOB
```
public int readBLOB(java.io.OutputStream out)
             throws java.io.IOException
```
    Description copied from interface: BLOBInputI
    
    Reads bytes from our DataInput and writes them to the passed OutputStream os.
    
    Specified by:
    
    readBLOB in interface BLOBInputI
    
    Throws:
    
    java.io.IOException
  - readBLOB
```
public int readBLOB(java.io.OutputStream out,
                    java.security.MessageDigest digester)
             throws java.io.IOException
```
    Specified by:
    
    readBLOB in interface DigestingBLOBInputI
    
    Throws:
    
    java.io.IOException
  - available
```
public int available()
              throws java.io.IOException
```
    Returns the number of bytes that can be read without blocking.
    
    Specified by:
    
    available in interface java.io.ObjectInput
    
    Throws:
    
    java.io.IOException
  - read
```
public int read()
         throws java.io.IOException
```
    Reads a byte of data.
    
    Specified by:
    
    read in interface java.io.ObjectInput
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(byte[] b)
         throws java.io.IOException
```
    Reads into an array of bytes.
    
    Specified by:
    
    read in interface java.io.ObjectInput
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException
```
    Reads into an array of bytes.
    
    Specified by:
    
    read in interface java.io.ObjectInput
    
    Throws:
    
    java.io.IOException
  - readObject
```
public java.lang.Object readObject()
                            throws java.io.IOException
```
    Read and return an object.
    
    Specified by:
    
    readObject in interface ObjectDataInputI
    
    Specified by:
    
    readObject in interface java.io.ObjectInput
    
    Throws:
    
    java.io.IOException
  - readObject
```
public java.lang.Object readObject(java.lang.Class[] expectedClasses)
                            throws java.io.IOException
```
    Description copied from interface: ObjectDataInputI
    
    Reads an Object from our DataInput, expecting an object of one of the given classes.
    
    Specified by:
    
    readObject in interface ObjectDataInputI
    
    Throws:
    
    java.io.IOException
  - skip
```
public long skip(long n)
```
    Skips n bytes of input.
    
    Specified by:
    
    skip in interface java.io.ObjectInput

Class CompactObjectInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompactObjectInput

CompactObjectInput

CompactObjectInput

CompactObjectInput

Method Detail

setBlocksize

setSidebandHandler

setObjectTransferHandler

handleSideband

close

readBoolean

readByte

readChar

readDouble

readFloat

readFully

readFully

readLine

readLong

readInt

readShort

readUnsignedByte

readUnsignedShort

readUTF

skipBytes

readBooleanObject

readByteObject

readDoubleObject

readFloatObject

readIntegerObject

readLongObject

readShortObject

readBigDecimal

readString

readDate

readStringArray

readIntegerArray

readLongArray

readObjectArray

readBLOB

readBLOB

_readBLOB

readBLOB

readBLOB

readBLOB

readBLOB

available

read

read

read

readObject

readObject

skip