Package com.esotericsoftware.kryo.io
Class ByteBufferInput
java.lang.Object
java.io.InputStream
com.esotericsoftware.kryo.io.Input
com.esotericsoftware.kryo.io.ByteBufferInput
- All Implemented Interfaces:
Closeable
,AutoCloseable
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.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) ByteOrder
protected static final ByteOrder
protected ByteBuffer
protected boolean
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an uninitialized Input.ByteBufferInput
(byte[] buffer) ByteBufferInput
(int bufferSize) Creates a new Input for reading from a byte array.ByteBufferInput
(InputStream inputStream) Creates a new Input for reading from an InputStream with a buffer size of 4096.ByteBufferInput
(InputStream inputStream, int bufferSize) Creates a new Input for reading from an InputStream.ByteBufferInput
(ByteBuffer buffer) Creates a new Input for reading from a ByteBuffer. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if enough bytes are available to read an int withreadInt(boolean)
.boolean
Returns true if enough bytes are available to read a long withreadLong(boolean)
.void
close()
Closes the underlying InputStream, if any.protected int
fill
(ByteBuffer buffer, int offset, int count) Fills the buffer with more bytes.boolean
Return current setting for variable length encoding of integersprivate boolean
private int
optional
(int optional) order()
void
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.private String
private String
boolean
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
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
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
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.private int
readInt_slow
(boolean optimizePositive) int[]
readInts
(int length) Bulk input of an int array.long
readLong()
Reads an 8 byte long.long
readLong
(boolean optimizePositive) Reads a 1-9 byte long.private long
readLong_slow
(boolean optimizePositive) long[]
readLongs
(int length) Bulk input of a long array.short
Reads a 2 byte short.short[]
readShorts
(int length) Bulk input of a short array.int
Reads a 2 byte short as an int from 0 to 65535.Reads the length and string of UTF8 characters, or null.Reads the length and string of UTF8 characters, or null.private void
readUtf8
(int charCount) private void
readUtf8_slow
(int charCount, int charIndex) private int
readUtf8Length
(int b) private int
readUtf8Length_slow
(int b) int
readVarInt
(boolean optimizePositive) Reads a 1-5 byte int.long
readVarLong
(boolean optimizePositive) Reads a 1-9 byte long.protected final int
require
(int required) void
rewind()
Sets the position and total to zero.void
setBuffer
(byte[] bytes) Sets a new buffer, discarding any previous buffer.void
setBuffer
(ByteBuffer buffer) Sets a new buffer, discarding any previous 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
setVarIntsEnabled
(boolean varIntsEnabled) Controls if a variable length encoding for integer types should be used when serializers suggest it.void
skip
(int count) Discards the specified number of bytes.long
skip
(long count) Discards the specified number of bytes.Methods inherited from class com.esotericsoftware.kryo.io.Input
available, eof, fill, getBuffer, limit, position, readInts, readLongs, setBuffer, setTotal, total
Methods inherited from class java.io.InputStream
mark, markSupported, reset
-
Field Details
-
niobuffer
-
varIntsEnabled
protected boolean varIntsEnabled -
byteOrder
ByteOrder byteOrder -
nativeOrder
-
-
Constructor Details
-
ByteBufferInput
public ByteBufferInput()Creates an uninitialized Input. A buffer must be set before the Input is used.- See Also:
-
ByteBufferInput
public ByteBufferInput(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.
-
ByteBufferInput
public ByteBufferInput(byte[] buffer) -
ByteBufferInput
Creates a new Input for reading from a ByteBuffer. -
ByteBufferInput
Creates a new Input for reading from an InputStream with a buffer size of 4096. -
ByteBufferInput
Creates a new Input for reading from an InputStream.
-
-
Method Details
-
order
-
order
-
setBuffer
public void setBuffer(byte[] bytes) Sets a new buffer, discarding any previous buffer. The position and total are reset. -
setBuffer
Sets a new buffer, discarding any previous buffer. The byte order, position, limit and capacity are set to match the specified buffer. The total is reset. TheInputStream
is set to null. -
getByteBuffer
-
getInputStream
- Overrides:
getInputStream
in classInput
-
setInputStream
Sets a new InputStream. The position and total are reset, discarding any buffered bytes.- Overrides:
setInputStream
in classInput
- Parameters:
inputStream
- May be null.
-
rewind
public void rewind()Description copied from class:Input
Sets the position and total to zero. -
fill
Fills the buffer with more bytes. Can be overridden to fill the bytes from a source other than the InputStream.- Throws:
KryoException
-
require
- Overrides:
require
in classInput
- Parameters:
required
- Must be > 0. The buffer is filled until it has at least this many bytes.- Returns:
- the number of bytes remaining.
- Throws:
KryoException
- if EOS is reached before required bytes are read (buffer underflow).
-
optional
- Parameters:
optional
- Try to fill the buffer with this many bytes.- Returns:
- the number of bytes remaining, but not more than optional, or -1 if the EOS was reached and the buffer is empty.
- Throws:
KryoException
-
read
Reads a single byte as an int from 0 to 255, or -1 if there are no more bytes are available.- Overrides:
read
in classInput
- Throws:
KryoException
-
read
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 classInput
- Throws:
KryoException
-
read
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 classInput
- Throws:
KryoException
-
setPosition
public void setPosition(int position) Description copied from class:Input
Sets the current position in the buffer.- Overrides:
setPosition
in classInput
-
setLimit
public void setLimit(int limit) Sets the limit in the buffer. -
skip
Description copied from class:Input
Discards the specified number of bytes.- Overrides:
skip
in classInput
- Throws:
KryoException
-
skip
Discards the specified number of bytes.- Overrides:
skip
in classInput
- Throws:
KryoException
-
close
Closes the underlying InputStream, if any.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInput
- Throws:
KryoException
-
readByte
Reads a single byte.- Overrides:
readByte
in classInput
- Throws:
KryoException
-
readByteUnsigned
Reads a byte as an int from 0 to 255.- Overrides:
readByteUnsigned
in classInput
- Throws:
KryoException
-
readBytes
Reads the specified number of bytes into a new byte[].- Overrides:
readBytes
in classInput
- Throws:
KryoException
-
readBytes
Reads bytes.length bytes and writes them to the specified byte[], starting at index 0.- Overrides:
readBytes
in classInput
- Throws:
KryoException
-
readBytes
Reads count bytes and writes them to the specified byte[], starting at offset.- Overrides:
readBytes
in classInput
- Throws:
KryoException
-
readInt
Description copied from class:Input
Reads a 4 byte int.- Overrides:
readInt
in classInput
- Throws:
KryoException
-
readInt
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 classInput
- Throws:
KryoException
-
readVarInt
Description copied from class:Input
Reads a 1-5 byte int. It is guaranteed that a varible length encoding will be used.- Overrides:
readVarInt
in classInput
- Throws:
KryoException
-
readInt_slow
private int readInt_slow(boolean optimizePositive) -
canReadInt
Returns true if enough bytes are available to read an int withreadInt(boolean)
.- Overrides:
canReadInt
in classInput
- Throws:
KryoException
-
canReadLong
Returns true if enough bytes are available to read a long withreadLong(boolean)
.- Overrides:
canReadLong
in classInput
- Throws:
KryoException
-
readString
Reads the length and string of UTF8 characters, or null. This can read strings written byOutput.writeString(String)
,Output.writeString(CharSequence)
, andOutput.writeAscii(String)
.- Overrides:
readString
in classInput
- Returns:
- May be null.
-
readUtf8Length
private int readUtf8Length(int b) -
readUtf8Length_slow
private int readUtf8Length_slow(int b) -
readUtf8
private void readUtf8(int charCount) -
readUtf8_slow
private void readUtf8_slow(int charCount, int charIndex) -
readAscii
-
readAscii_slow
-
readStringBuilder
Reads the length and string of UTF8 characters, or null. This can read strings written byOutput.writeString(String)
,Output.writeString(CharSequence)
, andOutput.writeAscii(String)
.- Overrides:
readStringBuilder
in classInput
- Returns:
- May be null.
-
readFloat
Reads a 4 byte float.- Overrides:
readFloat
in classInput
- Throws:
KryoException
-
readFloat
Reads a 1-5 byte float with reduced precision.- Overrides:
readFloat
in classInput
- Throws:
KryoException
-
readShort
Reads a 2 byte short.- Overrides:
readShort
in classInput
- Throws:
KryoException
-
readShortUnsigned
Reads a 2 byte short as an int from 0 to 65535.- Overrides:
readShortUnsigned
in classInput
- Throws:
KryoException
-
readLong
Reads an 8 byte long.- Overrides:
readLong
in classInput
- Throws:
KryoException
-
readLong
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 classInput
- Throws:
KryoException
-
readVarLong
Reads a 1-9 byte long. It is guaranteed that a varible length encoding will be used.- Overrides:
readVarLong
in classInput
- Throws:
KryoException
-
readLong_slow
private long readLong_slow(boolean optimizePositive) -
readBoolean
Reads a 1 byte boolean.- Overrides:
readBoolean
in classInput
- Throws:
KryoException
-
readChar
Reads a 2 byte char.- Overrides:
readChar
in classInput
- Throws:
KryoException
-
readDouble
Reads an 8 bytes double.- Overrides:
readDouble
in classInput
- Throws:
KryoException
-
readDouble
Reads a 1-9 byte double with reduced precision.- Overrides:
readDouble
in classInput
- Throws:
KryoException
-
readInts
Bulk input of an int array.- Overrides:
readInts
in classInput
- Throws:
KryoException
-
readLongs
Bulk input of a long array.- Overrides:
readLongs
in classInput
- Throws:
KryoException
-
readFloats
Bulk input of a float array.- Overrides:
readFloats
in classInput
- Throws:
KryoException
-
readShorts
Bulk input of a short array.- Overrides:
readShorts
in classInput
- Throws:
KryoException
-
readChars
Bulk input of a char array.- Overrides:
readChars
in classInput
- Throws:
KryoException
-
readDoubles
Bulk input of a double array.- Overrides:
readDoubles
in classInput
- Throws:
KryoException
-
isNativeOrder
private boolean isNativeOrder() -
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
-
-