Package org.opensearch.core.common.io.stream

Class InputStreamStreamInput

java.lang.Object

java.io.InputStream

org.opensearch.core.common.io.stream.StreamInput

org.opensearch.core.common.io.stream.InputStreamStreamInput

All Implemented Interfaces:

Closeable, AutoCloseable

public class InputStreamStreamInput
extends StreamInput

Main input stream for input data

Opensearch.internal:

Constructor Summary

Constructors

Constructor	Description
InputStreamStreamInput(InputStream is)	Creates a new InputStreamStreamInput with unlimited size
InputStreamStreamInput(InputStream is, long sizeLimit)	Creates a new InputStreamStreamInput with a size limit

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.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
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.
void	reset()
long	skip(long n)

Methods inherited from class org.opensearch.core.common.io.stream.StreamInput

getVersion, namedWriteableRegistry, readArray, readBigInteger, readBoolean, readBuild, readByteArray, readBytesRef, readBytesRef, readBytesReference, readBytesReference, readDouble, readDoubleArray, readEnum, readEnumSet, readException, readFloat, readFloatArray, readFully, readGenericValue, readInstant, readInt, readIntArray, readList, readLong, readLongArray, readMap, readMap, readMapOfLists, readMediaType, readNamedWriteable, readNamedWriteable, readNamedWriteableList, readOptionalArray, readOptionalBoolean, readOptionalBytesReference, readOptionalDouble, readOptionalFloat, readOptionalInstant, readOptionalInt, readOptionalLong, readOptionalNamedWriteable, readOptionalSecureString, readOptionalString, readOptionalStringArray, readOptionalStringList, readOptionalText, readOptionalTimeValue, readOptionalVInt, readOptionalVLong, readOptionalWriteable, readOptionalZoneId, readOrderedMap, readOrderedMap, readSecureString, readSemverRange, readSet, readShort, readString, readStringArray, readStringList, readText, readTimeValue, readVersion, readVInt, readVIntArray, readVLong, readVLongArray, readZLong, readZoneId, setVersion, wrap, wrap

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

InputStreamStreamInput

public InputStreamStreamInput(InputStream is)

Creates a new InputStreamStreamInput with unlimited size

Parameters:

is - the input stream to wrap

InputStreamStreamInput

public InputStreamStreamInput(InputStream is,
 long sizeLimit)

Creates a new InputStreamStreamInput with a size limit

Parameters:

is - the input stream to wrap

sizeLimit - a hard limit of the number of bytes in the given input stream. This is used for internal input validation

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

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readlimit)

Overrides:

mark 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

available

public int available()
              throws IOException

Specified by:

available in class StreamInput

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

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