Module org.elasticsearch.server

Package org.elasticsearch.common.io.stream

Class BytesRefStreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

org.elasticsearch.common.io.stream.BytesRefStreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, org.apache.lucene.util.Accountable

public class BytesRefStreamOutput
extends StreamOutput
implements org.apache.lucene.util.Accountable

A @link StreamOutput that is backed by a BytesRef. This is useful for small data, for larger or unknown sizes use BytesStreamOutput instead. Compared to BytesStreamOutput this class avoids copying the bytes ref. Compared to BytesRefBuilder this class supports writing all the rich data types that StreamOutput supports.

Field Summary

Fields inherited from class org.elasticsearch.common.io.stream.StreamOutput

GENERIC_LIST_HEADER

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
BytesRefStreamOutput()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream to further operations.
void	flush()	Forces any buffered output to be written.
org.apache.lucene.util.BytesRef	get()
long	position()
long	ramBytesUsed()
void	reset()
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.
void	writeGenericString(String value)	Write a String within StreamOutput.writeGenericValue(java.lang.Object), represented as the type code byte 0 followed by the string itself written as if with StreamOutput.writeString(java.lang.String).
void	writeOptionalString(String str)	Write a possibly-null String, represented as a invalid reference boolean which is false if the string is null, or else true if it is not null, and in this latter case it is followed by the string itself written as if with StreamOutput.writeString(java.lang.String).
void	writeString(String str)	Write a String: its length in Unicode code units (chars) (NB not bytes) written using StreamOutput.writeVInt(int) followed by the sequence of characters themselves encoded as UTF-8.

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

checkWriteable, getTransportVersion, legacyWriteWithSizePrefix, setTransportVersion, write, write, writeArray, writeArray, writeBigInteger, writeBoolean, writeByteArray, writeBytes, writeBytes, writeBytesRef, writeBytesReference, writeCollection, writeCollection, writeDouble, writeDoubleArray, writeDoubleLE, writeEnum, writeEnumSet, writeException, writeFloat, writeFloatArray, writeGenericList, writeGenericMap, writeGenericNull, writeGenericValue, writeGeoPoint, writeInstant, writeInt, writeIntArray, writeIntLE, writeLong, writeLongArray, writeLongLE, writeMap, writeMap, writeMap, writeMapValues, writeMapValues, writeMapWithConsistentOrder, writeMissingString, writeMissingWriteable, writeNamedWriteable, writeNamedWriteableCollection, writeOptional, writeOptionalArray, writeOptionalArray, writeOptionalBoolean, writeOptionalByteArray, writeOptionalBytesReference, writeOptionalCollection, writeOptionalCollection, writeOptionalDouble, writeOptionalEnum, writeOptionalException, writeOptionalFloat, writeOptionalFloatArray, writeOptionalInstant, writeOptionalInt, writeOptionalLong, writeOptionalMap, writeOptionalNamedWriteable, writeOptionalNamedWriteableCollection, writeOptionalSecureString, writeOptionalStringArray, writeOptionalStringCollection, writeOptionalText, writeOptionalTimeValue, writeOptionalVInt, writeOptionalVLong, writeOptionalWriteable, writeOptionalZoneId, writeSecureString, writeShort, writeStringArray, writeStringArrayNullable, writeStringCollection, writeText, writeTimeValue, writeVInt, writeVIntArray, writeVLong, writeVLongArray, writeWithSizePrefix, writeWriteable, writeZLong, writeZoneId

Methods inherited from class java.io.OutputStream

nullOutputStream, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Constructor Details

BytesRefStreamOutput

public BytesRefStreamOutput()

Method Details

get

public org.apache.lucene.util.BytesRef get()

position

public long position()

Specified by:

position in class StreamOutput

Returns:

the current position of the stream, in bytes. Increases as data is written to the stream. If the stream is seekable then the seek operation updates the current position().

writeByte

public void writeByte(byte b)

Description copied from class: StreamOutput

Writes a single byte.

Specified by:

writeByte in class StreamOutput

writeBytes

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

Description copied from class: StreamOutput

Writes an array of bytes.

Specified by:

writeBytes in class StreamOutput

Parameters:

b - the bytes to write

offset - the offset in the byte array

length - the number of bytes to write

writeString

public void writeString(String str)
                 throws IOException

Description copied from class: StreamOutput

Write a String: its length in Unicode code units (chars) (NB not bytes) written using StreamOutput.writeVInt(int) followed by the sequence of characters themselves encoded as UTF-8.

May be performance-critical, so subclasses must specify an explicit implementation. If performance is unimportant, consider using StreamOutputHelper.writeString(java.lang.String, java.io.OutputStream).

Specified by:

writeString in class StreamOutput

Throws:

IOException

writeOptionalString

public void writeOptionalString(@Nullable
 String str)
                         throws IOException

Description copied from class: StreamOutput

Write a possibly-null String, represented as a

invalid reference

boolean

which is false if the string is null, or else true if it is not null, and in this latter case it is followed by the string itself written as if with StreamOutput.writeString(java.lang.String).

May be performance-critical, so subclasses must specify an explicit implementation. If performance is unimportant, consider using StreamOutputHelper.writeOptionalString(java.lang.String, java.io.OutputStream).

Specified by:

writeOptionalString in class StreamOutput

Throws:

IOException

writeGenericString

public void writeGenericString(String value)
                        throws IOException

Description copied from class: StreamOutput

Write a String within StreamOutput.writeGenericValue(java.lang.Object), represented as the type code byte 0 followed by the string itself written as if with StreamOutput.writeString(java.lang.String).

May be performance-critical, so subclasses must specify an explicit implementation. If performance is unimportant, consider using StreamOutputHelper.writeGenericString(java.lang.String, java.io.OutputStream).

Specified by:

writeGenericString in class StreamOutput

Throws:

IOException

flush

public void flush()

Description copied from class: StreamOutput

Forces any buffered output to be written.

Specified by:

flush in interface Flushable

Specified by:

flush in class StreamOutput

close

public void close()

Closes this stream to further operations. This is a no-op, as the underlying BytesRefBuilder has no IO resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class StreamOutput

reset

public void reset()

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable