Package com.prineside.kryo

Class FixedInput

java.lang.Object
java.io.InputStream
com.prineside.kryo.FixedInput
All Implemented Interfaces:
Closeable, AutoCloseable
public class FixedInput extends InputStream
An InputStream that reads data from a byte array and optionally fills the byte array from another InputStream as needed. Utility methods are provided for efficiently reading primitive types and strings.

The byte[] buffer may be modified and then returned to its original state during some read operations, so the same byte[] should not be used concurrently in separate threads.

Author:
Nathan Sweet <[email protected]>

  • Constructor Summary

    Constructors
    Constructor
    Description
    FixedInput()
    Creates an uninitialized Input.
    FixedInput(byte[] buffer)
    Creates a new Input for reading from a byte array.
    FixedInput(byte[] buffer, int offset, int count)
    Creates a new Input for reading from a byte array.
    FixedInput(int bufferSize)
    Creates a new Input for reading from a byte array.
    FixedInput(InputStream inputStream)
    Creates a new Input for reading from an InputStream with a buffer size of 4096.
    FixedInput(InputStream inputStream, int bufferSize)
    Creates a new Input for reading from an InputStream.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    available()
     
    boolean
    canReadInt()
    Returns true if enough bytes are available to read an int with readInt(boolean).
    boolean
    canReadLong()
    Returns true if enough bytes are available to read a long with readLong(boolean).
    void
    close()
    Closes the underlying InputStream, if any.
    boolean
    eof()
     
    byte[]
    getBuffer()
     
    InputStream
    getInputStream()
     
    final int
    limit()
    Returns the limit for the buffer.
    final int
    position()
    Returns the current position in the buffer.
    int
    read()
    Reads a single byte as an int from 0 to 255, or -1 if there are no more bytes are available.
    int
    read(byte[] bytes)
    Reads bytes.length bytes or less and writes them to the specified byte[], starting at 0, and returns the number of bytes read.
    int
    read(byte[] bytes, int offset, int count)
    Reads count bytes or less and writes them to the specified byte[], starting at offset, and returns the number of bytes read or -1 if no more bytes are available.
    boolean
    readBoolean()
    Reads a 1 byte boolean.
    byte
    readByte()
    Reads a single byte.
    void
    readBytes(byte[] bytes)
    Reads bytes.length bytes and writes them to the specified byte[], starting at index 0.
    void
    readBytes(byte[] bytes, int offset, int count)
    Reads count bytes and writes them to the specified byte[], starting at offset.
    byte[]
    readBytes(int length)
    Reads the specified number of bytes into a new byte[].
    int
    readByteUnsigned()
    Reads a byte as an int from 0 to 255.
    char
    readChar()
    Reads a 2 byte char.
    char[]
    readChars(int length)
    Bulk input of a char array.
    double
    readDouble()
    Reads an 8 bytes double.
    double
    readDouble(double precision, boolean optimizePositive)
    Reads a 1-9 byte double with reduced precision.
    double[]
    readDoubles(int length)
    Bulk input of a double array.
    float
    readFloat()
    Reads a 4 byte float.
    float
    readFloat(float precision, boolean optimizePositive)
    Reads a 1-5 byte float with reduced precision.
    float[]
    readFloats(int length)
    Bulk input of a float array.
    int
    readInt()
    Reads a 4 byte int.
    int
    readInt(boolean optimizePositive)
    Reads a 1-5 byte int.
    int[]
    readInts(int length)
    Bulk input of an int array.
    int[]
    readInts(int length, boolean optimizePositive)
    Bulk input of an int array.
    long
    readLong()
    Reads an 8 byte long.
    long
    readLong(boolean optimizePositive)
    Reads a 1-9 byte long.
    long[]
    readLongs(int length)
    Bulk input of a long array.
    long[]
    readLongs(int length, boolean optimizePositive)
    Bulk input of a long array.
    short
    readShort()
    Reads a 2 byte short.
    short[]
    readShorts(int length)
    Bulk input of a short array.
    int
    readShortUnsigned()
    Reads a 2 byte short as an int from 0 to 65535.
    String
    readString()
    Reads the length and string of UTF8 characters, or null.
    StringBuilder
    readStringBuilder()
    Reads the length and string of UTF8 characters, or null.
    int
    readVarInt(boolean optimizePositive)
    Reads a 1-5 byte int.
    long
    readVarLong(boolean optimizePositive)
    Reads a 1-9 byte long.
    void
    rewind()
    Sets the position and total to zero.
    void
    setBuffer(byte[] bytes)
    Sets a new buffer.
    void
    setBuffer(byte[] bytes, int offset, int count)
    Sets a new buffer.
    void
    setInputStream(InputStream inputStream)
    Sets a new InputStream.
    void
    setLimit(int limit)
    Sets the limit in the buffer.
    void
    setPosition(int position)
    Sets the current position in the buffer.
    void
    setTotal(int total)
    Sets the number of bytes read.
    void
    skip(int count)
    Discards the specified number of bytes.
    long
    skip(long count)
    Discards the specified number of bytes.
    long
    total()
    Returns the number of bytes read.

    Methods inherited from class java.io.InputStream

    mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skipNBytes, transferTo

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • FixedInput

      public FixedInput()
      Creates an uninitialized Input. setBuffer(byte[]) must be called before the Input is used.

    • FixedInput

      public FixedInput(int bufferSize)
      Creates a new Input for reading from a byte array.
      Parameters:
      bufferSize - The size of the buffer. An exception is thrown if more bytes than this are read.

    • FixedInput

      public FixedInput(byte[] buffer)
      Creates a new Input for reading from a byte array.
      Parameters:
      buffer - An exception is thrown if more bytes than this are read.

    • FixedInput

      public FixedInput(byte[] buffer, int offset, int count)
      Creates a new Input for reading from a byte array.
      Parameters:
      buffer - An exception is thrown if more bytes than this are read.

    • FixedInput

      public FixedInput(InputStream inputStream)
      Creates a new Input for reading from an InputStream with a buffer size of 4096.

    • FixedInput

      public FixedInput(InputStream inputStream, int bufferSize)
      Creates a new Input for reading from an InputStream.

  • Method Details

    • setBuffer

      public void setBuffer(byte[] bytes)
      Sets a new buffer. The position and total are reset, discarding any buffered bytes.

    • setBuffer

      public void setBuffer(byte[] bytes, int offset, int count)
      Sets a new buffer. The position and total are reset, discarding any buffered bytes.

    • getBuffer

      public byte[] getBuffer()

    • getInputStream

      public InputStream getInputStream()

    • setInputStream

      public void setInputStream(InputStream inputStream)
      Sets a new InputStream. The position and total are reset, discarding any buffered bytes.
      Parameters:
      inputStream - May be null.

    • total

      public long total()
      Returns the number of bytes read.

    • setTotal

      public void setTotal(int total)
      Sets the number of bytes read.

    • position

      public final int position()
      Returns the current position in the buffer.

    • setPosition

      public void setPosition(int position)
      Sets the current position in the buffer.

    • limit

      public final int limit()
      Returns the limit for the buffer.

    • setLimit

      public void setLimit(int limit)
      Sets the limit in the buffer.

    • rewind

      public void rewind()
      Sets the position and total to zero.

    • skip

      public void skip(int count) throws KryoException
      Discards the specified number of bytes.
      Throws:
      KryoException

    • eof

      public boolean eof()

    • available

      public int available() throws IOException
      Overrides:
      available in class InputStream
      Throws:
      IOException

    • read

      public int read() throws KryoException
      Reads a single byte as an int from 0 to 255, or -1 if there are no more bytes are available.
      Specified by:
      read in class InputStream
      Throws:
      KryoException

    • read

      public int read(byte[] bytes) throws KryoException
      Reads bytes.length bytes or less and writes them to the specified byte[], starting at 0, and returns the number of bytes read.
      Overrides:
      read in class InputStream
      Throws:
      KryoException

    • read

      public int read(byte[] bytes, int offset, int count) throws KryoException
      Reads count bytes or less and writes them to the specified byte[], starting at offset, and returns the number of bytes read or -1 if no more bytes are available.
      Overrides:
      read in class InputStream
      Throws:
      KryoException

    • skip

      public long skip(long count) throws KryoException
      Discards the specified number of bytes.
      Overrides:
      skip in class InputStream
      Throws:
      KryoException

    • close

      public void close() throws KryoException
      Closes the underlying InputStream, if any.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Overrides:
      close in class InputStream
      Throws:
      KryoException

    • readByte

      public byte readByte() throws KryoException
      Reads a single byte.
      Throws:
      KryoException

    • readByteUnsigned

      public int readByteUnsigned() throws KryoException
      Reads a byte as an int from 0 to 255.
      Throws:
      KryoException

    • readBytes

      public byte[] readBytes(int length) throws KryoException
      Reads the specified number of bytes into a new byte[].
      Throws:
      KryoException

    • readBytes

      public void readBytes(byte[] bytes) throws KryoException
      Reads bytes.length bytes and writes them to the specified byte[], starting at index 0.
      Throws:
      KryoException

    • readBytes

      public void readBytes(byte[] bytes, int offset, int count) throws KryoException
      Reads count bytes and writes them to the specified byte[], starting at offset.
      Throws:
      KryoException

    • readInt

      public int readInt() throws KryoException
      Reads a 4 byte int.
      Throws:
      KryoException

    • readInt

      public int readInt(boolean optimizePositive) throws KryoException
      Reads a 1-5 byte int. This stream may consider such a variable length encoding request as a hint. It is not guaranteed that a variable length encoding will be really used. The stream may decide to use native-sized integer representation for efficiency reasons.
      Throws:
      KryoException

    • readVarInt

      public int readVarInt(boolean optimizePositive) throws KryoException
      Reads a 1-5 byte int. It is guaranteed that a varible length encoding will be used.
      Throws:
      KryoException

    • canReadInt

      public boolean canReadInt() throws KryoException
      Returns true if enough bytes are available to read an int with readInt(boolean).
      Throws:
      KryoException

    • canReadLong

      public boolean canReadLong() throws KryoException
      Returns true if enough bytes are available to read a long with readLong(boolean).
      Throws:
      KryoException

    • readString

      public String readString()
      Reads the length and string of UTF8 characters, or null. This can read strings written by FixedOutput.writeString(String) , FixedOutput.writeString(CharSequence), and FixedOutput.writeAscii(String).
      Returns:
      May be null.

    • readStringBuilder

      public StringBuilder readStringBuilder()
      Reads the length and string of UTF8 characters, or null. This can read strings written by FixedOutput.writeString(String) , FixedOutput.writeString(CharSequence), and FixedOutput.writeAscii(String).
      Returns:
      May be null.

    • readFloat

      public float readFloat() throws KryoException
      Reads a 4 byte float.
      Throws:
      KryoException

    • readFloat

      public float readFloat(float precision, boolean optimizePositive) throws KryoException
      Reads a 1-5 byte float with reduced precision.
      Throws:
      KryoException

    • readShort

      public short readShort() throws KryoException
      Reads a 2 byte short.
      Throws:
      KryoException

    • readShortUnsigned

      public int readShortUnsigned() throws KryoException
      Reads a 2 byte short as an int from 0 to 65535.
      Throws:
      KryoException

    • readLong

      public long readLong() throws KryoException
      Reads an 8 byte long.
      Throws:
      KryoException

    • readLong

      public long readLong(boolean optimizePositive) throws KryoException
      Reads a 1-9 byte long. This stream may consider such a variable length encoding request as a hint. It is not guaranteed that a variable length encoding will be really used. The stream may decide to use native-sized integer representation for efficiency reasons.
      Throws:
      KryoException

    • readVarLong

      public long readVarLong(boolean optimizePositive) throws KryoException
      Reads a 1-9 byte long. It is guaranteed that a varible length encoding will be used.
      Throws:
      KryoException

    • readBoolean

      public boolean readBoolean() throws KryoException
      Reads a 1 byte boolean.
      Throws:
      KryoException

    • readChar

      public char readChar() throws KryoException
      Reads a 2 byte char.
      Throws:
      KryoException

    • readDouble

      public double readDouble() throws KryoException
      Reads an 8 bytes double.
      Throws:
      KryoException

    • readDouble

      public double readDouble(double precision, boolean optimizePositive) throws KryoException
      Reads a 1-9 byte double with reduced precision.
      Throws:
      KryoException

    • readInts

      public int[] readInts(int length, boolean optimizePositive) throws KryoException
      Bulk input of an int array.
      Throws:
      KryoException

    • readLongs

      public long[] readLongs(int length, boolean optimizePositive) throws KryoException
      Bulk input of a long array.
      Throws:
      KryoException

    • readInts

      public int[] readInts(int length) throws KryoException
      Bulk input of an int array.
      Throws:
      KryoException

    • readLongs

      public long[] readLongs(int length) throws KryoException
      Bulk input of a long array.
      Throws:
      KryoException

    • readFloats

      public float[] readFloats(int length) throws KryoException
      Bulk input of a float array.
      Throws:
      KryoException

    • readShorts

      public short[] readShorts(int length) throws KryoException
      Bulk input of a short array.
      Throws:
      KryoException

    • readChars

      public char[] readChars(int length) throws KryoException
      Bulk input of a char array.
      Throws:
      KryoException

    • readDoubles

      public double[] readDoubles(int length) throws KryoException
      Bulk input of a double array.
      Throws:
      KryoException