org.elasticsearch.common.io.stream

Class StreamInput

java.lang.Object

java.io.InputStream

org.elasticsearch.common.io.stream.StreamInput

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

BufferedChecksumStreamInput, ByteBufferStreamInput, ChannelBufferStreamInput, CompressedStreamInput, FilterStreamInput, InputStreamStreamInput

public abstract class StreamInput
extends InputStream

Constructor Summary

Constructors

Constructor and Description
StreamInput()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Closes the stream to further operations.
Version	getVersion()
boolean	readBoolean() Reads a boolean.
abstract byte	readByte() Reads and returns a single byte.
byte[]	readByteArray()
abstract void	readBytes(byte[] b, int offset, int len) Reads a specified number of bytes into an array at the specified offset.
org.apache.lucene.util.BytesRef	readBytesRef()
org.apache.lucene.util.BytesRef	readBytesRef(int length)
BytesReference	readBytesReference() Reads a bytes reference from this stream, might hold an actual reference to the underlying bytes of the stream.
BytesReference	readBytesReference(int length) Reads a bytes reference from this stream, might hold an actual reference to the underlying bytes of the stream.
double	readDouble()
double[]	readDoubleArray()
float	readFloat()
float[]	readFloatArray()
void	readFully(byte[] b)
Object	readGenericValue()
GeoPoint	readGeoPoint() Reads a GeoPoint from this stream input
int	readInt() Reads four bytes and returns an int.
int[]	readIntArray()
<T> List<T>	readList(StreamInputReader<T> reader) Reads a list of objects
long	readLong() Reads eight bytes and returns a long.
long[]	readLongArray()
Map<String,Object>	readMap()
Boolean	readOptionalBoolean()
<T extends Streamable> T	readOptionalStreamable(T streamable) Serializes a potential null value.
String	readOptionalString()
Text	readOptionalText()
Integer	readOptionalVInt()
short	readShort()
String	readString()
String[]	readStringArray()
Task.Status	readTaskStatus() Reads a Task.Status from the current stream.
Text	readText()
<T extends Throwable> T	readThrowable()
int	readVInt() Reads an int stored in variable-length format.
int[]	readVIntArray()
long	readVLong() Reads a long stored in variable-length format.
long[]	readVLongArray()
abstract void	reset() Resets the stream.
void	setVersion(Version version)
static StreamInput	wrap(byte[] bytes)
static StreamInput	wrap(byte[] bytes, int offset, int length)
static StreamInput	wrap(BytesReference reference)

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, read, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamInput

public StreamInput()

Method Detail

getVersion

public Version getVersion()

setVersion

public void setVersion(Version version)

readByte

public abstract byte readByte()
                       throws IOException

Reads and returns a single byte.

Throws:

IOException

readBytes

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

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

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

readBytesReference

public BytesReference readBytesReference()
                                  throws IOException

Reads a bytes reference from this stream, might hold an actual reference to the underlying bytes of the stream.

Throws:

IOException

readBytesReference

public BytesReference readBytesReference(int length)
                                  throws IOException

Reads a bytes reference from this stream, might hold an actual reference to the underlying bytes of the stream.

Throws:

IOException

readBytesRef

public org.apache.lucene.util.BytesRef readBytesRef()
                                             throws IOException

Throws:

IOException

readBytesRef

public org.apache.lucene.util.BytesRef readBytesRef(int length)
                                             throws IOException

Throws:

IOException

readFully

public void readFully(byte[] b)
               throws IOException

Throws:

IOException

readShort

public short readShort()
                throws IOException

Throws:

IOException

readInt

public int readInt()
            throws IOException

Reads four bytes and returns an int.

Throws:

IOException

readVInt

public int readVInt()
             throws IOException

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

Throws:

IOException

readLong

public long readLong()
              throws IOException

Reads eight bytes and returns a long.

Throws:

IOException

readVLong

public long readVLong()
               throws IOException

Reads a long stored in variable-length format. Reads between one and nine bytes. Smaller values take fewer bytes. Negative numbers are not supported.

Throws:

IOException

readOptionalText

@Nullable
public Text readOptionalText()
                      throws IOException

Throws:

IOException

readText

public Text readText()
              throws IOException

Throws:

IOException

readOptionalString

@Nullable
public String readOptionalString()
                          throws IOException

Throws:

IOException

readOptionalVInt

@Nullable
public Integer readOptionalVInt()
                         throws IOException

Throws:

IOException

readString

public String readString()
                  throws IOException

Throws:

IOException

readFloat

public final float readFloat()
                      throws IOException

Throws:

IOException

readDouble

public final double readDouble()
                        throws IOException

Throws:

IOException

readBoolean

public final boolean readBoolean()
                          throws IOException

Reads a boolean.

Throws:

IOException

readOptionalBoolean

@Nullable
public final Boolean readOptionalBoolean()
                                  throws IOException

Throws:

IOException

reset

public abstract void reset()
                    throws IOException

Resets the stream.

Overrides:

reset in class InputStream

Throws:

IOException

close

public abstract void close()
                    throws IOException

Closes the stream to further operations.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

readStringArray

public String[] readStringArray()
                         throws IOException

Throws:

IOException

readMap

@Nullable
public Map<String,Object> readMap()
                           throws IOException

Throws:

IOException

readGenericValue

@Nullable
public Object readGenericValue()
                        throws IOException

Throws:

IOException

readGeoPoint

public GeoPoint readGeoPoint()
                      throws IOException

Reads a GeoPoint from this stream input

Throws:

IOException

readIntArray

public int[] readIntArray()
                   throws IOException

Throws:

IOException

readVIntArray

public int[] readVIntArray()
                    throws IOException

Throws:

IOException

readLongArray

public long[] readLongArray()
                     throws IOException

Throws:

IOException

readVLongArray

public long[] readVLongArray()
                      throws IOException

Throws:

IOException

readFloatArray

public float[] readFloatArray()
                       throws IOException

Throws:

IOException

readDoubleArray

public double[] readDoubleArray()
                         throws IOException

Throws:

IOException

readByteArray

public byte[] readByteArray()
                     throws IOException

Throws:

IOException

readOptionalStreamable

public <T extends Streamable> T readOptionalStreamable(T streamable)
                                            throws IOException

Serializes a potential null value.

Throws:

IOException

readThrowable

public <T extends Throwable> T readThrowable()
                                  throws IOException

Throws:

IOException

readTaskStatus

public Task.Status readTaskStatus()
                           throws IOException

Reads a Task.Status from the current stream.

Throws:

IOException

readList

public <T> List<T> readList(StreamInputReader<T> reader)
                 throws IOException

Reads a list of objects

Throws:

IOException

wrap

public static StreamInput wrap(BytesReference reference)

wrap

public static StreamInput wrap(byte[] bytes)

wrap

public static StreamInput wrap(byte[] bytes,
               int offset,
               int length)