Package org.elasticsearch.common.io.stream

Class FilterStreamInput

java.lang.Object

java.io.InputStream

org.elasticsearch.common.io.stream.StreamInput

org.elasticsearch.common.io.stream.FilterStreamInput

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BufferedChecksumStreamInput, NamedWriteableAwareStreamInput

public abstract class FilterStreamInput
extends StreamInput

Wraps a StreamInput and delegates to it. To be used to add functionality to an existing stream by subclassing.

Field Summary

Fields

Modifier and Type	Field	Description
protected StreamInput	delegate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FilterStreamInput(StreamInput delegate)

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 this stream.
Version	getVersion()	The version of the node on the other side of this stream.
NamedWriteableRegistry	namedWriteableRegistry()	Get the registry of named writeables if this stream has one, null otherwise.
int	read()
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.
ReleasableBytesReference	readReleasableBytesReference()	Reads a releasable bytes reference from this stream.
short	readShort()
int	readVInt()	Reads an int stored in variable-length format.
long	readVLong()	Reads a long stored in variable-length format.
void	reset()
void	setVersion(Version version)	Set the version of the node on the other side of this stream.

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

readArray, readArraySize, readBigInteger, readBoolean, readByteArray, readBytesRef, readBytesRef, readBytesReference, readBytesReference, readDouble, readDoubleArray, readEnum, readEnumSet, readException, readFloat, readFloatArray, readFully, readGenericValue, readGeoPoint, readImmutableMap, readInstant, readIntArray, readList, readLongArray, readMap, readMap, readMapOfLists, readNamedWriteable, readNamedWriteable, readNamedWriteableList, readOptionalArray, readOptionalBoolean, readOptionalBytesReference, readOptionalDouble, readOptionalEnum, readOptionalFloat, readOptionalInstant, readOptionalInt, readOptionalLong, readOptionalNamedWriteable, readOptionalSecureString, readOptionalString, readOptionalStringArray, readOptionalStringList, readOptionalText, readOptionalTimeValue, readOptionalTimeZone, readOptionalVInt, readOptionalVLong, readOptionalWriteable, readOptionalZoneId, readOrderedMap, readSecureString, readSet, readString, readStringArray, readStringList, readText, readTimeValue, readTimeZone, readVIntArray, readVIntSlow, readVLongArray, readVLongSlow, readZLong, readZoneId, throwOnBrokenVInt, throwOnBrokenVLong, wrap, wrap

Methods inherited from class java.io.InputStream

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

Methods inherited from class java.lang.Object

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

Field Details

delegate

protected final StreamInput delegate

Constructor Details

FilterStreamInput

protected FilterStreamInput(StreamInput delegate)

Method Details

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

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

readReleasableBytesReference

public ReleasableBytesReference readReleasableBytesReference()
                                                      throws IOException

Description copied from class: StreamInput

Reads a releasable bytes reference from this stream. Unlike StreamInput.readBytesReference() the returned bytes reference may reference bytes in a pooled buffer and must be explicitly released via ReleasableBytesReference.close() once no longer used. Prefer this method over StreamInput.readBytesReference() when reading large bytes references to avoid allocations and copying.

Overrides:

readReleasableBytesReference in class StreamInput

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

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

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

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

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

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

available

public int available()
              throws IOException

Specified by:

available in class StreamInput

Throws:

IOException

getVersion

public Version getVersion()

Description copied from class: StreamInput

The version of the node on the other side of this stream.

Overrides:

getVersion in class StreamInput

setVersion

public void setVersion(Version version)

Description copied from class: StreamInput

Set the version of the node on the other side of this stream.

Overrides:

setVersion in class StreamInput

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 this 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

namedWriteableRegistry

public NamedWriteableRegistry namedWriteableRegistry()

Description copied from class: StreamInput

Get the registry of named writeables if this stream has one, null otherwise.

Overrides:

namedWriteableRegistry in class StreamInput