Package com.aoindustries.io.stream

Class StreamableInput

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.DataInputStream

com.aoindustries.io.stream.StreamableInput

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable

public class StreamableInput
extends DataInputStream

Adds compressed data transfer to DataInputStream. This class is not thread safe.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
StreamableInput(InputStream in)

Method Summary

Modifier and Type	Method	Description
int	readCompressedInt()	Reads a compressed integer from the stream.
static int	readCompressedInt(InputStream in)	Reads a compressed integer from the stream.
String	readCompressedUTF()
<T extends Enum<T>> T	readEnum(Class<T> enumType)	Reads an Enum, represented by its Enum.name().
Identifier	readIdentifier()	Reads an Identifier.
String	readLongUTF()	Reads a string of any length.
Boolean	readNullBoolean()
Byte	readNullByte()
<T extends Enum<T>> T	readNullEnum(Class<T> enumType)	Reads an Enum, represented by its Enum.name(), supporting null.
Identifier	readNullIdentifier()	Reads a possibly-null Identifier.
Integer	readNullInteger()
Long	readNullLong()
String	readNullLongUTF()	Reads a string of any length, supporting null.
Short	readNullShort()
SmallIdentifier	readNullSmallIdentifier()	Reads a possibly-null Identifier.
Timestamp	readNullTimestamp()	Reads a possibly-null Timestamp.
UnmodifiableTimestamp	readNullUnmodifiableTimestamp()	Reads a possibly-null UnmodifiableTimestamp.
String	readNullUTF()
SmallIdentifier	readSmallIdentifier()	Reads a SmallIdentifier.
Timestamp	readTimestamp()	Reads a Timestamp.
static Timestamp	readTimestamp(DataInputStream in)	Reads a Timestamp, maintaining the full nanosecond precision.
UnmodifiableTimestamp	readUnmodifiableTimestamp()	Reads an UnmodifiableTimestamp.
static UnmodifiableTimestamp	readUnmodifiableTimestamp(DataInputStream in)	Reads an UnmodifiableTimestamp, maintaining the full nanosecond precision.

Methods inherited from class java.io.DataInputStream

read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, readUTF, skipBytes

Methods inherited from class java.io.FilterInputStream

available, close, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamableInput

public StreamableInput(InputStream in)

Method Detail

readCompressedInt

public static int readCompressedInt(InputStream in)
                             throws IOException

Reads a compressed integer from the stream. The 31 bit pattern is as follows:

 5 bit   - 000SXXXX
 13 bit  - 001SXXXX XXXXXXXX
 22 bit  - 01SXXXXX XXXXXXXX XXXXXXXX
 31 bit  - 1SXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX
 

Throws:

EOFException - if the end of file is reached

IOException

readCompressedInt

public int readCompressedInt()
                      throws IOException

Reads a compressed integer from the stream. The 31 bit pattern is as follows:

 5 bit   - 000SXXXX
 13 bit  - 001SXXXX XXXXXXXX
 22 bit  - 01SXXXXX XXXXXXXX XXXXXXXX
 31 bit  - 1SXXXXXX XXXXXXXX XXXXXXXX XXXXXXXX
 

Throws:

EOFException - if the end of file is reached

IOException

readCompressedUTF

public String readCompressedUTF()
                         throws IOException

Throws:

EOFException - if the end of file is reached

IOException

readNullUTF

public String readNullUTF()
                   throws IOException

Throws:

IOException

readLongUTF

public String readLongUTF()
                   throws IOException

Reads a string of any length.

Throws:

IOException

readNullLongUTF

public String readNullLongUTF()
                       throws IOException

Reads a string of any length, supporting null.

Throws:

IOException

readNullByte

public Byte readNullByte()
                  throws IOException

Throws:

IOException

readNullShort

public Short readNullShort()
                    throws IOException

Throws:

IOException

readNullInteger

public Integer readNullInteger()
                        throws IOException

Throws:

IOException

readNullLong

public Long readNullLong()
                  throws IOException

Throws:

IOException

readEnum

public <T extends Enum<T>> T readEnum(Class<T> enumType)
                               throws IOException

Reads an Enum, represented by its Enum.name().

Throws:

IOException

readNullEnum

public <T extends Enum<T>> T readNullEnum(Class<T> enumType)
                                   throws IOException

Reads an Enum, represented by its Enum.name(), supporting null.

Throws:

IOException

readNullBoolean

public Boolean readNullBoolean()
                        throws IOException

Throws:

IOException

readTimestamp

public static Timestamp readTimestamp(DataInputStream in)
                               throws IOException

Reads a Timestamp, maintaining the full nanosecond precision. Time zone offset is not maintained.

See StreamableOutput.writeTimestamp(java.sql.Timestamp, java.io.DataOutputStream) for wire protocol details.

Throws:

IOException

readTimestamp

public Timestamp readTimestamp()
                        throws IOException

Reads a Timestamp.

Throws:

IOException

See Also:

readTimestamp(java.io.DataInputStream)

readNullTimestamp

public Timestamp readNullTimestamp()
                            throws IOException

Reads a possibly-null Timestamp.

Throws:

IOException

See Also:

readTimestamp()

readUnmodifiableTimestamp

public static UnmodifiableTimestamp readUnmodifiableTimestamp(DataInputStream in)
                                                       throws IOException

Reads an UnmodifiableTimestamp, maintaining the full nanosecond precision. Time zone offset is not maintained.

See StreamableOutput.writeTimestamp(java.sql.Timestamp, java.io.DataOutputStream) for wire protocol details.

Throws:

IOException

readUnmodifiableTimestamp

public UnmodifiableTimestamp readUnmodifiableTimestamp()
                                                throws IOException

Reads an UnmodifiableTimestamp.

Throws:

IOException

See Also:

readUnmodifiableTimestamp(java.io.DataInputStream)

readNullUnmodifiableTimestamp

public UnmodifiableTimestamp readNullUnmodifiableTimestamp()
                                                    throws IOException

Reads a possibly-null UnmodifiableTimestamp.

Throws:

IOException

See Also:

readUnmodifiableTimestamp()

readIdentifier

public Identifier readIdentifier()
                          throws IOException

Reads an Identifier.

Throws:

IOException

readNullIdentifier

public Identifier readNullIdentifier()
                              throws IOException

Reads a possibly-null Identifier.

Throws:

IOException

readSmallIdentifier

public SmallIdentifier readSmallIdentifier()
                                    throws IOException

Reads a SmallIdentifier.

Throws:

IOException

readNullSmallIdentifier

public SmallIdentifier readNullSmallIdentifier()
                                        throws IOException

Reads a possibly-null Identifier.

Throws:

IOException