com.esotericsoftware.kryo.io

Class UnsafeInput

java.lang.Object

java.io.InputStream

com.esotericsoftware.kryo.io.Input

com.esotericsoftware.kryo.io.UnsafeInput

All Implemented Interfaces:

Closeable, AutoCloseable

public final class UnsafeInput
extends Input

An optimized 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 writing primitive types, arrays of primitive types and strings. It uses

Author:

Roman Levenstein

Field Summary

Fields inherited from class com.esotericsoftware.kryo.io.Input

buffer, capacity, chars, inputStream, limit, position, total

Constructor Summary

Constructors

Constructor and Description
UnsafeInput() Creates an uninitialized Input.
UnsafeInput(byte[] buffer) Creates a new Input for reading from a byte array.
UnsafeInput(byte[] buffer, int offset, int count) Creates a new Input for reading from a byte array.
UnsafeInput(InputStream inputStream) Creates a new Input for reading from an InputStream.
UnsafeInput(InputStream inputStream, int bufferSize) Creates a new Input for reading from an InputStream.
UnsafeInput(int bufferSize) Creates a new Input for reading from a byte array.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getVarIntsEnabled() Return current setting for variable length encoding of integers
void	readBytes(Object dstObj, long offset, long count)
char	readChar() Reads a 2 byte char.
char[]	readChars(int length) Bulk input of a char array.
double	readDouble() Writes an 8 byte double.
double[]	readDoubles(int length) Bulk input of a double array.
float	readFloat() Reads a 4 byte float.
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.
void	setVarIntsEnabled(boolean varIntsEnabled) Controls if a variable length encoding for integer types should be used when serializers suggest it.

Methods inherited from class com.esotericsoftware.kryo.io.Input

available, canReadInt, canReadLong, close, eof, fill, getBuffer, getInputStream, limit, position, read, read, read, readBoolean, readByte, readBytes, readBytes, readBytes, readByteUnsigned, readDouble, readFloat, readShortUnsigned, readString, readStringBuilder, readVarInt, readVarLong, require, rewind, setBuffer, setBuffer, setInputStream, setLimit, setPosition, setTotal, skip, skip, total

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

UnsafeInput

public UnsafeInput()

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

UnsafeInput

public UnsafeInput(int bufferSize)

Creates a new Input for reading from a byte array.

Parameters:

bufferSize - The initial and maximum size of the buffer. An exception is thrown if this size is exceeded.

UnsafeInput

public UnsafeInput(byte[] buffer)

Creates a new Input for reading from a byte array.

See Also:

Input.setBuffer(byte[])

UnsafeInput

public UnsafeInput(byte[] buffer,
           int offset,
           int count)

Creates a new Input for reading from a byte array.

See Also:

Input.setBuffer(byte[], int, int)

UnsafeInput

public UnsafeInput(InputStream inputStream)

Creates a new Input for reading from an InputStream. A buffer size of 4096 is used.

UnsafeInput

public UnsafeInput(InputStream inputStream,
           int bufferSize)

Creates a new Input for reading from an InputStream.

Method Detail

readInt

public int readInt()
            throws KryoException

Reads a 4 byte int.

Overrides:

readInt in class Input

Throws:

KryoException

readFloat

public float readFloat()
                throws KryoException

Reads a 4 byte float.

Overrides:

readFloat in class Input

Throws:

KryoException

readShort

public short readShort()
                throws KryoException

Reads a 2 byte short.

Overrides:

readShort in class Input

Throws:

KryoException

readLong

public long readLong()
              throws KryoException

Reads an 8 byte long.

Overrides:

readLong in class Input

Throws:

KryoException

readDouble

public double readDouble()
                  throws KryoException

Writes an 8 byte double.

Overrides:

readDouble in class Input

Throws:

KryoException

readChar

public char readChar()
              throws KryoException

Description copied from class: Input

Reads a 2 byte char.

Overrides:

readChar in class Input

Throws:

KryoException

readInt

public int readInt(boolean optimizePositive)
            throws KryoException

Description copied from class: Input

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.

Overrides:

readInt in class Input

Throws:

KryoException

readLong

public long readLong(boolean optimizePositive)
              throws KryoException

Description copied from class: Input

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.

Overrides:

readLong in class Input

Throws:

KryoException

readInts

public final int[] readInts(int length,
             boolean optimizePositive)
                     throws KryoException

Bulk input of an int array.

Overrides:

readInts in class Input

Throws:

KryoException

readLongs

public final long[] readLongs(int length,
               boolean optimizePositive)
                       throws KryoException

Bulk input of a long array.

Overrides:

readLongs in class Input

Throws:

KryoException

readInts

public final int[] readInts(int length)
                     throws KryoException

Bulk input of an int array.

Overrides:

readInts in class Input

Throws:

KryoException

readLongs

public final long[] readLongs(int length)
                       throws KryoException

Bulk input of a long array.

Overrides:

readLongs in class Input

Throws:

KryoException

readFloats

public final float[] readFloats(int length)
                         throws KryoException

Bulk input of a float array.

Overrides:

readFloats in class Input

Throws:

KryoException

readShorts

public final short[] readShorts(int length)
                         throws KryoException

Bulk input of a short array.

Overrides:

readShorts in class Input

Throws:

KryoException

readChars

public final char[] readChars(int length)
                       throws KryoException

Bulk input of a char array.

Overrides:

readChars in class Input

Throws:

KryoException

readDoubles

public final double[] readDoubles(int length)
                           throws KryoException

Bulk input of a double array.

Overrides:

readDoubles in class Input

Throws:

KryoException

readBytes

public final void readBytes(Object dstObj,
             long offset,
             long count)
                     throws KryoException

Throws:

KryoException

getVarIntsEnabled

public boolean getVarIntsEnabled()

Return current setting for variable length encoding of integers

Returns:

current setting for variable length encoding of integers

setVarIntsEnabled

public void setVarIntsEnabled(boolean varIntsEnabled)

Controls if a variable length encoding for integer types should be used when serializers suggest it.

Parameters:

varIntsEnabled -