Module org.elasticsearch.server

Package org.elasticsearch.common.io.stream

Class ByteBufferStreamInput

java.lang.Object

java.io.InputStream

org.elasticsearch.common.io.stream.StreamInput

org.elasticsearch.common.io.stream.ByteBufferStreamInput

All Implemented Interfaces:

Closeable, AutoCloseable

public class ByteBufferStreamInput
extends StreamInput

Constructor Summary

Constructors

Constructor	Description
ByteBufferStreamInput(ByteBuffer buffer)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()	Closes the stream to further operations.
protected void	ensureCanReadBytes(int length)	This method throws an EOFException if the given number of bytes can not be read from the stream.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
byte	readByte()	Reads and returns a single byte.
void	readBytes(byte[] b, int offset, int len)	Reads a specified number of bytes into an array at the specified offset.
int	readInt()	Reads four bytes and returns an int.
long	readLong()	Reads eight bytes and returns a long.
short	readShort()
BytesReference	readSlicedBytesReference()	Reads the same bytes returned by StreamInput.readReleasableBytesReference() but does not retain a reference to these bytes.
String	readString()
int	readVInt()	Reads an int stored in variable-length format.
static int	readVInt(ByteBuffer buffer)	Read a vInt encoded in the format written by StreamOutput.writeVInt(int) from a ByteBuffer.
long	readVLong()	Reads a long stored in variable-length format.
static long	readVLong(ByteBuffer buffer)	Read a vLong encoded in the format written by StreamOutput.writeVLong(long) from a ByteBuffer.
void	reset()
long	skip(long n)

Methods inherited from class org.elasticsearch.common.io.stream.StreamInput

doReadString, getTransportVersion, namedWriteableRegistry, readAllToReleasableBytesReference, readArray, readArraySize, readBigInteger, readBoolean, readByteArray, readBytesRef, readBytesRef, readBytesReference, readBytesReference, readCollection, readCollectionAsImmutableList, readCollectionAsImmutableSet, readCollectionAsList, readCollectionAsSet, readDouble, readDoubleArray, readEnum, readEnumSet, readException, readFloat, readFloatArray, readFully, readGenericMap, readGenericValue, readGeoPoint, readImmutableMap, readImmutableMap, readImmutableOpenMap, readInstant, readIntArray, readLongArray, readMap, readMap, readMapOfLists, readMapValues, readNamedWriteable, readNamedWriteable, readNamedWriteableCollectionAsList, readOptional, readOptionalArray, readOptionalBoolean, readOptionalByteArray, readOptionalBytesReference, readOptionalCollectionAsList, readOptionalDouble, readOptionalEnum, readOptionalFloat, readOptionalFloatArray, readOptionalInstant, readOptionalInt, readOptionalLong, readOptionalNamedWriteable, readOptionalSecureString, readOptionalString, readOptionalStringArray, readOptionalStringCollectionAsList, readOptionalText, readOptionalTimeValue, readOptionalVInt, readOptionalVLong, readOptionalWriteable, readOptionalZoneId, readOrderedMap, readReleasableBytesReference, readSecureString, readStringArray, readStringCollectionAsImmutableList, readStringCollectionAsList, readText, readTimeValue, readVIntArray, readVIntSlow, readVLongArray, readVLongSlow, readZLong, readZoneId, setTransportVersion, supportReadAllToReleasableBytesReference, throwEOF, throwOnBrokenVInt, throwOnBrokenVLong, throwOnNullRead, tryReadStringFromBytes, wrap, wrap

Methods inherited from class java.io.InputStream

nullInputStream, read, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ByteBufferStreamInput

public ByteBufferStreamInput(ByteBuffer buffer)

Method Details

readVInt

public static int readVInt(ByteBuffer buffer)
                    throws IOException

Read a vInt encoded in the format written by StreamOutput.writeVInt(int) from a ByteBuffer. The buffer is assumed to contain enough bytes to fully read the value and its position is moved by this method.

Parameters:

buffer - buffer to read from

Returns:

value read from the buffer

Throws:

IOException - if buffer does not contain a valid vInt starting from the current position

readVLong

public static long readVLong(ByteBuffer buffer)
                      throws IOException

Read a vLong encoded in the format written by StreamOutput.writeVLong(long) from a ByteBuffer. The buffer is assumed to contain enough bytes to fully read the value and its position is moved by this method.

Parameters:

buffer - buffer to read from

Returns:

value read from the buffer

Throws:

IOException - if buffer does not contain a valid vLong starting from the current position

readString

public String readString()
                  throws IOException

Overrides:

readString in class StreamInput

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Description copied from class: StreamInput

Reads and returns a single byte.

Specified by:

readByte in class StreamInput

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Specified by:

read in class StreamInput

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

readBytes

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

Description copied from class: StreamInput

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

Specified by:

readBytes in class StreamInput

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

Overrides:

readShort in class StreamInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Description copied from class: StreamInput

Reads four bytes and returns an int.

Overrides:

readInt in class StreamInput

Throws:

IOException

readVInt

public int readVInt()
             throws IOException

Description copied from class: StreamInput

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 StreamInput.readInt()

Overrides:

readVInt in class StreamInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Description copied from class: StreamInput

Reads eight bytes and returns a long.

Overrides:

readLong in class StreamInput

Throws:

IOException

readVLong

public long readVLong()
               throws IOException

Description copied from class: StreamInput

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 StreamInput.readLong() or StreamInput.readZLong() for negative numbers.

Overrides:

readVLong in class StreamInput

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Specified by:

available in class StreamInput

Throws:

IOException

ensureCanReadBytes

protected void ensureCanReadBytes(int length)
                           throws EOFException

Description copied from class: StreamInput

This method throws an EOFException if the given number of bytes can not be read from the stream. This method might be a no-op depending on the underlying implementation if the information of the remaining bytes is not present.

Specified by:

ensureCanReadBytes in class StreamInput

Throws:

EOFException

readSlicedBytesReference

public BytesReference readSlicedBytesReference()
                                        throws IOException

Description copied from class: StreamInput

Reads the same bytes returned by StreamInput.readReleasableBytesReference() but does not retain a reference to these bytes. The returned BytesReference thus only contains valid content as long as the underlying buffer has not been released. This method should be preferred over StreamInput.readReleasableBytesReference() when the returned reference is known to not be used past the lifetime of the underlying buffer as it requires fewer allocations and does not require a potentially costly reference count change.

Overrides:

readSlicedBytesReference in class StreamInput

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

close

public void close()
           throws IOException

Description copied from class: StreamInput

Closes the stream to further operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class StreamInput

Throws:

IOException