Package cn.sliew.milky.common.io.stream

Class StreamInput

java.lang.Object

java.io.InputStream

cn.sliew.milky.common.io.stream.StreamInput

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

InputStreamStreamInput

public abstract class StreamInput
extends InputStream

A stream from this node to another node. Technically, it can also be streamed to a byte array but that is mostly for testing.

This class's methods are optimized so you can put the methods that read and write a class next to each other and you can scan them visually for differences. That means that most variables should be read and written in a single line so even large objects fit both reading and writing on the screen. It also means that the methods on this class are named very similarly to StreamOutput. Finally it means that the "barrier to entry" for adding new methods to this class is relatively low even though it is a shared class with code everywhere. That being said, this class deals primarily with Lists rather than Arrays. For the most part calls should adapt to lists, either by storing Lists internally or just converting to and from a List when calling. This comment is repeated on StreamInput.

Constructor Summary

Constructors

Constructor	Description
StreamInput()

Method Summary

Modifier and Type	Method	Description
abstract int	available()
abstract void	close()	Closes the stream to further operations.
boolean	readBoolean()	Reads a boolean.
abstract byte	readByte()	Reads and returns a single byte.
abstract void	readBytes(byte[] b, int offset, int len)	Reads a specified number of bytes into an array at the specified offset.
double	readDouble()
float	readFloat()
Object	readGenericValue()	Reads a value of unspecified type.
int	readInt()	Reads four bytes and returns an int.
long	readLong()	Reads eight bytes and returns a long.
Boolean	readOptionalBoolean()
Double	readOptionalDouble()
Float	readOptionalFloat()
Integer	readOptionalInt()	Reads an optional Integer.
Long	readOptionalLong()
Integer	readOptionalVInt()
Long	readOptionalVLong()
short	readShort()
int	readVInt()	Reads an int stored in variable-length format.
long	readVLong()	Reads a long stored in variable-length format.
long	readZLong()
static StreamInput	wrap(byte[] bytes)
static StreamInput	wrap(byte[] bytes, int offset, int length)

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, read, read, readAllBytes, readNBytes, readNBytes, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamInput

public StreamInput()

Method Detail

wrap

public static StreamInput wrap(byte[] bytes)

wrap

public static StreamInput wrap(byte[] bytes,
                               int offset,
                               int length)

close

public abstract void close()
                    throws IOException

Closes the stream to further operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

available

public abstract int available()
                       throws IOException

Overrides:

available in class InputStream

Throws:

IOException

readByte

public abstract byte readByte()
                       throws IOException

Reads and returns a single byte.

Throws:

IOException

readBytes

public abstract void readBytes(byte[] b,
                               int offset,
                               int len)
                        throws IOException

Reads a specified number of bytes into an array at the specified offset.

Parameters:

b - the array to read bytes into

offset - the offset in the array to start storing bytes

len - the number of bytes to read

Throws:

IOException

readShort

public short readShort()
                throws IOException

Throws:

IOException

readInt

public int readInt()
            throws IOException

Reads four bytes and returns an int.

Throws:

IOException

readOptionalInt

public Integer readOptionalInt()
                        throws IOException

Reads an optional Integer.

Throws:

IOException

readVInt

public int readVInt()
             throws IOException

Reads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers will always use all 5 bytes and are therefore better serialized using readInt()

Throws:

IOException

readOptionalVInt

public Integer readOptionalVInt()
                         throws IOException

Throws:

IOException

readLong

public long readLong()
              throws IOException

Reads eight bytes and returns a long.

Throws:

IOException

readOptionalLong

public Long readOptionalLong()
                      throws IOException

Throws:

IOException

readVLong

public long readVLong()
               throws IOException

Reads a long stored in variable-length format. Reads between one and ten bytes. Smaller values take fewer bytes. Negative numbers are encoded in ten bytes so prefer readLong() or readZLong() for negative numbers.

Throws:

IOException

readOptionalVLong

public Long readOptionalVLong()
                       throws IOException

Throws:

IOException

readZLong

public long readZLong()
               throws IOException

Throws:

IOException

readFloat

public final float readFloat()
                      throws IOException

Throws:

IOException

readOptionalFloat

public Float readOptionalFloat()
                        throws IOException

Throws:

IOException

readDouble

public final double readDouble()
                        throws IOException

Throws:

IOException

readOptionalDouble

public final Double readOptionalDouble()
                                throws IOException

Throws:

IOException

readBoolean

public final boolean readBoolean()
                          throws IOException

Reads a boolean.

Throws:

IOException

readOptionalBoolean

public final Boolean readOptionalBoolean()
                                  throws IOException

Throws:

IOException

readGenericValue

public Object readGenericValue()
                        throws IOException

Reads a value of unspecified type. If a collection is read then the collection will be mutable if it contains any entry but might be immutable if it is empty.

Throws:

IOException