org.elasticsearch.common.io.stream

Class StreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

AdapterStreamOutput, BufferedChecksumStreamOutput, BytesStreamOutput, CompressedStreamOutput, DataOutputStreamOutput, NoopStreamOutput, OutputStreamStreamOutput

public abstract class StreamOutput
extends OutputStream

Constructor Summary

Constructors

Constructor and Description
StreamOutput()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes this stream to further operations.
abstract void	flush() Forces any buffered output to be written.
Version	getVersion()
long	position()
abstract void	reset()
void	seek(long position)
boolean	seekPositionSupported()
StreamOutput	setVersion(Version version)
void	write(byte[] b, int off, int len)
void	write(int b)
void	writeBoolean(boolean b) Writes a boolean.
abstract void	writeByte(byte b) Writes a single byte.
void	writeByteArray(byte[] b) Writes an array of bytes.
void	writeBytes(byte[] b) Writes an array of bytes.
void	writeBytes(byte[] b, int length) Writes an array of bytes.
abstract void	writeBytes(byte[] b, int offset, int length) Writes an array of bytes.
void	writeBytesRef(org.apache.lucene.util.BytesRef bytes)
void	writeBytesReference(BytesReference bytes) Writes the bytes reference, including a length header.
void	writeDouble(double v)
void	writeDoubleArray(double[] value)
void	writeFloat(float v)
void	writeFloatArray(float[] value)
void	writeGenericValue(Object value)
void	writeInt(int i) Writes an int as four bytes.
void	writeIntArray(int[] value)
void	writeLong(long i) Writes a long as eight bytes.
void	writeLongArray(long[] value)
void	writeMap(Map<String,Object> map)
void	writeOptionalBoolean(Boolean b)
void	writeOptionalSharedString(String str)
void	writeOptionalStreamable(Streamable streamable) Serializes a potential null value.
void	writeOptionalString(String str)
void	writeOptionalText(Text text)
void	writeSharedString(String str)
void	writeSharedText(Text text)
void	writeShort(short v)
void	writeString(String str)
void	writeStringArray(String[] array)
void	writeStringArrayNullable(String[] array) Writes a string array, for nullable string, writes it as 0 (empty string).
void	writeText(Text text)
void	writeTextArray(Text[] array)
void	writeVInt(int i) Writes an int in a variable-length format.
void	writeVLong(long i) Writes an long in a variable-length format.

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamOutput

public StreamOutput()

Method Detail

getVersion

public Version getVersion()

setVersion

public StreamOutput setVersion(Version version)

seekPositionSupported

public boolean seekPositionSupported()

position

public long position()
              throws IOException

Throws:

IOException

seek

public void seek(long position)
          throws IOException

Throws:

IOException

writeByte

public abstract void writeByte(byte b)
                        throws IOException

Writes a single byte.

Throws:

IOException

writeBytes

public void writeBytes(byte[] b)
                throws IOException

Writes an array of bytes.

Parameters:

b - the bytes to write

Throws:

IOException

writeBytes

public void writeBytes(byte[] b,
                       int length)
                throws IOException

Writes an array of bytes.

Parameters:

b - the bytes to write

length - the number of bytes to write

Throws:

IOException

writeBytes

public abstract void writeBytes(byte[] b,
                                int offset,
                                int length)
                         throws IOException

Writes an array of bytes.

Parameters:

b - the bytes to write

offset - the offset in the byte array

length - the number of bytes to write

Throws:

IOException

writeByteArray

public void writeByteArray(byte[] b)
                    throws IOException

Writes an array of bytes.

Parameters:

b - the bytes to write

Throws:

IOException

writeBytesReference

public void writeBytesReference(@Nullable
                                BytesReference bytes)
                         throws IOException

Writes the bytes reference, including a length header.

Throws:

IOException

writeBytesRef

public void writeBytesRef(org.apache.lucene.util.BytesRef bytes)
                   throws IOException

Throws:

IOException

writeShort

public final void writeShort(short v)
                      throws IOException

Throws:

IOException

writeInt

public void writeInt(int i)
              throws IOException

Writes an int as four bytes.

Throws:

IOException

writeVInt

public void writeVInt(int i)
               throws IOException

Writes an int in a variable-length format. Writes between one and five bytes. Smaller values take fewer bytes. Negative numbers will always use all 5 bytes and are therefore better serialized using writeInt(int)

Throws:

IOException

writeLong

public void writeLong(long i)
               throws IOException

Writes a long as eight bytes.

Throws:

IOException

writeVLong

public void writeVLong(long i)
                throws IOException

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

Throws:

IOException

writeOptionalString

public void writeOptionalString(@Nullable
                                String str)
                         throws IOException

Throws:

IOException

writeOptionalSharedString

public void writeOptionalSharedString(@Nullable
                                      String str)
                               throws IOException

Throws:

IOException

writeOptionalText

public void writeOptionalText(@Nullable
                              Text text)
                       throws IOException

Throws:

IOException

writeText

public void writeText(Text text)
               throws IOException

Throws:

IOException

writeTextArray

public void writeTextArray(Text[] array)
                    throws IOException

Throws:

IOException

writeSharedText

public void writeSharedText(Text text)
                     throws IOException

Throws:

IOException

writeString

public void writeString(String str)
                 throws IOException

Throws:

IOException

writeSharedString

public void writeSharedString(String str)
                       throws IOException

Throws:

IOException

writeFloat

public void writeFloat(float v)
                throws IOException

Throws:

IOException

writeDouble

public void writeDouble(double v)
                 throws IOException

Throws:

IOException

writeBoolean

public void writeBoolean(boolean b)
                  throws IOException

Writes a boolean.

Throws:

IOException

writeOptionalBoolean

public void writeOptionalBoolean(@Nullable
                                 Boolean b)
                          throws IOException

Throws:

IOException

flush

public abstract void flush()
                    throws IOException

Forces any buffered output to be written.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public abstract void close()
                    throws IOException

Closes this stream to further operations.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

reset

public abstract void reset()
                    throws IOException

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

writeStringArray

public void writeStringArray(String[] array)
                      throws IOException

Throws:

IOException

writeStringArrayNullable

public void writeStringArrayNullable(@Nullable
                                     String[] array)
                              throws IOException

Writes a string array, for nullable string, writes it as 0 (empty string).

Throws:

IOException

writeMap

public void writeMap(@Nullable
                     Map<String,Object> map)
              throws IOException

Throws:

IOException

writeGenericValue

public void writeGenericValue(@Nullable
                              Object value)
                       throws IOException

Throws:

IOException

writeIntArray

public void writeIntArray(int[] value)
                   throws IOException

Throws:

IOException

writeLongArray

public void writeLongArray(long[] value)
                    throws IOException

Throws:

IOException

writeFloatArray

public void writeFloatArray(float[] value)
                     throws IOException

Throws:

IOException

writeDoubleArray

public void writeDoubleArray(double[] value)
                      throws IOException

Throws:

IOException

writeOptionalStreamable

public void writeOptionalStreamable(@Nullable
                                    Streamable streamable)
                             throws IOException

Serializes a potential null value.

Throws:

IOException