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:

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FilterStreamInput(StreamInput delegate)

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
void	close() Closes the stream to further operations.
Version	getVersion()
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.
void	reset() Resets the stream.
void	setVersion(Version version)

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

readBoolean, readByteArray, readBytesRef, readBytesRef, readBytesReference, readBytesReference, readDouble, readDoubleArray, readFloat, readFloatArray, readFully, readGenericValue, readGeoPoint, readInt, readIntArray, readList, readLong, readLongArray, readMap, readOptionalBoolean, readOptionalStreamable, readOptionalString, readOptionalText, readOptionalVInt, readShort, readString, readStringArray, readTaskStatus, readText, readThrowable, readVInt, readVIntArray, readVLong, readVLongArray, wrap, wrap, wrap

Methods inherited from class java.io.InputStream

mark, markSupported, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterStreamInput

protected FilterStreamInput(StreamInput delegate)

Method Detail

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

reset

public void reset()
           throws IOException

Description copied from class: StreamInput

Resets the stream.

Specified by:

reset in class StreamInput

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 Closeable

Specified by:

close in interface AutoCloseable

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()

Overrides:

getVersion in class StreamInput

setVersion

public void setVersion(Version version)

Overrides:

setVersion in class StreamInput