Module org.elasticsearch.server

Package org.elasticsearch.common.io.stream

Class CountingStreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

org.elasticsearch.common.io.stream.CountingStreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class CountingStreamOutput
extends StreamOutput

A reusable @link StreamOutput that just count how many bytes are written.

Field Summary

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

GENERIC_LIST_HEADER

Constructor Summary

Constructors

Constructor	Description
CountingStreamOutput()

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream to further operations.
void	flush()	Forces any buffered output to be written.
long	position()
void	reset()	reset the written byes to 0
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.
void	writeDouble(double v)
void	writeDoubleArray(double[] values)
void	writeFloat(float v)
void	writeFloatArray(float[] values)
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	writeInt(int i)	Writes an int as four bytes.
void	writeIntArray(int[] values)
void	writeIntLE(int i)	Writes an int as four bytes, least significant bytes first.
void	writeLong(long i)	Writes a long as eight bytes.
void	writeLongArray(long[] values)
void	writeLongLE(long i)	Writes a long as eight bytes.
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	writeShort(short v)
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.
void	writeVInt(int v)	Writes an int in a variable-length format.
void	writeZLong(long i)	Writes a long in a variable-length format.

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, writeDoubleLE, writeEnum, writeEnumSet, writeException, writeGenericList, writeGenericMap, writeGenericNull, writeGenericValue, writeGeoPoint, writeInstant, 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, writeStringArray, writeStringArrayNullable, writeStringCollection, writeText, writeTimeValue, writeVIntArray, writeVLong, writeVLongArray, writeWithSizePrefix, writeWriteable, 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

Constructor Details

CountingStreamOutput

public CountingStreamOutput()

Method Details

reset

public void reset()

reset the written byes to 0

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

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

writeShort

public void writeShort(short v)
                throws IOException

Overrides:

writeShort in class StreamOutput

Throws:

IOException

writeInt

public void writeInt(int i)

Description copied from class: StreamOutput

Writes an int as four bytes.

Overrides:

writeInt in class StreamOutput

writeIntLE

public void writeIntLE(int i)
                throws IOException

Description copied from class: StreamOutput

Writes an int as four bytes, least significant bytes first.

Overrides:

writeIntLE in class StreamOutput

Throws:

IOException

writeIntArray

public void writeIntArray(int[] values)

Overrides:

writeIntArray in class StreamOutput

writeLong

public void writeLong(long i)

Description copied from class: StreamOutput

Writes a long as eight bytes.

Overrides:

writeLong in class StreamOutput

writeLongLE

public void writeLongLE(long i)

Description copied from class: StreamOutput

Writes a long as eight bytes.

Overrides:

writeLongLE in class StreamOutput

writeLongArray

public void writeLongArray(long[] values)

Overrides:

writeLongArray in class StreamOutput

writeFloat

public void writeFloat(float v)

Overrides:

writeFloat in class StreamOutput

writeFloatArray

public void writeFloatArray(float[] values)

Overrides:

writeFloatArray in class StreamOutput

writeDouble

public void writeDouble(double v)

Overrides:

writeDouble in class StreamOutput

writeDoubleArray

public void writeDoubleArray(double[] values)

Overrides:

writeDoubleArray in class StreamOutput

writeVInt

public void writeVInt(int v)

Description copied from class: StreamOutput

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 StreamOutput.writeInt(int)

Overrides:

writeVInt in class StreamOutput

writeZLong

public void writeZLong(long i)

Description copied from class: StreamOutput

Writes a long in a variable-length format. Writes between one and ten bytes. Values are remapped by sliding the sign bit into the lsb and then encoded as an unsigned number e.g., 0 -;> 0, -1 -;> 1, 1 -;> 2, ..., Long.MIN_VALUE -;> -1, Long.MAX_VALUE -;> -2 Numbers with small absolute value will have a small encoding If the numbers are known to be non-negative, use StreamOutput.writeVLong(long)

Overrides:

writeZLong in class StreamOutput

writeString

public void writeString(String str)

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

writeOptionalString

public void writeOptionalString(@Nullable
 String str)

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

writeGenericString

public void writeGenericString(String value)

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

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

Description copied from class: StreamOutput

Closes this stream to further operations.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class StreamOutput