Class FilterStreamInput
- java.lang.Object
-
- java.io.InputStream
-
- org.elasticsearch.common.io.stream.StreamInput
-
- org.elasticsearch.common.io.stream.FilterStreamInput
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
- Direct Known Subclasses:
BufferedChecksumStreamInput
,NamedWriteableAwareStreamInput
public abstract class FilterStreamInput extends StreamInput
Wraps aStreamInput
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 anEOFException
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.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()
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, readBoolean, readByteArray, readBytesRef, readBytesRef, readBytesReference, readBytesReference, readDouble, readDoubleArray, readEnum, readEnumSet, readException, readFloat, readFloatArray, readFully, readGenericValue, readGeoPoint, readInstant, readInt, readIntArray, readList, readLong, readLongArray, readMap, readMap, readMapOfLists, readNamedWriteable, readNamedWriteable, readNamedWriteableList, readOptionalArray, readOptionalBoolean, readOptionalBytesReference, readOptionalDouble, readOptionalFloat, readOptionalInstant, readOptionalInt, readOptionalLong, readOptionalNamedWriteable, readOptionalSecureString, readOptionalStreamable, readOptionalString, readOptionalStringArray, readOptionalText, readOptionalTimeValue, readOptionalTimeZone, readOptionalVInt, readOptionalWriteable, readOptionalZoneId, readSecureString, readSet, readShort, readStreamableList, readString, readStringArray, readStringList, readText, readTimeValue, readTimeZone, readVInt, readVIntArray, readVLong, readVLongArray, readZLong, readZoneId, wrap, wrap
-
-
-
-
Field Detail
-
delegate
protected final StreamInput delegate
-
-
Constructor Detail
-
FilterStreamInput
protected FilterStreamInput(StreamInput delegate)
-
-
Method Detail
-
readByte
public byte readByte() throws java.io.IOException
Description copied from class:StreamInput
Reads and returns a single byte.- Specified by:
readByte
in classStreamInput
- Throws:
java.io.IOException
-
readBytes
public void readBytes(byte[] b, int offset, int len) throws java.io.IOException
Description copied from class:StreamInput
Reads a specified number of bytes into an array at the specified offset.- Specified by:
readBytes
in classStreamInput
- Parameters:
b
- the array to read bytes intooffset
- the offset in the array to start storing byteslen
- the number of bytes to read- Throws:
java.io.IOException
-
reset
public void reset() throws java.io.IOException
- Overrides:
reset
in classjava.io.InputStream
- Throws:
java.io.IOException
-
read
public int read() throws java.io.IOException
- Specified by:
read
in classjava.io.InputStream
- Throws:
java.io.IOException
-
close
public void close() throws java.io.IOException
Description copied from class:StreamInput
Closes the stream to further operations.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in classStreamInput
- Throws:
java.io.IOException
-
available
public int available() throws java.io.IOException
- Specified by:
available
in classStreamInput
- Throws:
java.io.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 classStreamInput
-
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 classStreamInput
-
ensureCanReadBytes
protected void ensureCanReadBytes(int length) throws java.io.EOFException
Description copied from class:StreamInput
This method throws anEOFException
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 classStreamInput
- Throws:
java.io.EOFException
-
-