Package org.elasticsearch.common.io.stream

Class VersionCheckingStreamOutput

java.lang.Object

java.io.OutputStream

org.elasticsearch.common.io.stream.StreamOutput

org.elasticsearch.common.io.stream.VersionCheckingStreamOutput

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class VersionCheckingStreamOutput
extends StreamOutput

This StreamOutput writes nowhere. It can be used to check if serialization would be successful writing to a specific version.

Constructor Summary

Constructors

Constructor	Description
VersionCheckingStreamOutput(Version version)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this stream to further operations.
void	flush()	Forces any buffered output to be written.
void	reset()
void	writeByte(byte b)	Writes a single byte.
void	writeBytes(byte[] b, int offset, int length)	Writes an array of bytes.
void	writeNamedWriteable(NamedWriteable namedWriteable)	Writes a NamedWriteable to the current stream, by first writing its name and then the object itself
void	writeOptionalNamedWriteable(NamedWriteable namedWriteable)	Write an optional NamedWriteable to the stream.

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

checkWriteable, getVersion, position, seek, setVersion, write, write, writeArray, writeArray, writeBoolean, writeByteArray, writeBytes, writeBytes, writeBytesRef, writeBytesReference, writeCollection, writeCollection, writeDouble, writeDoubleArray, writeEnum, writeEnumSet, writeException, writeFloat, writeFloatArray, writeGenericValue, writeGeoPoint, writeInstant, writeInt, writeIntArray, writeList, writeLong, writeLongArray, writeMap, writeMap, writeMap, writeMap, writeMapOfLists, writeMapWithConsistentOrder, writeMissingString, writeMissingWriteable, writeNamedWriteableList, writeOptionalArray, writeOptionalArray, writeOptionalBoolean, writeOptionalBytesReference, writeOptionalDouble, writeOptionalEnum, writeOptionalFloat, writeOptionalInstant, writeOptionalInt, writeOptionalLong, writeOptionalSecureString, writeOptionalString, writeOptionalStringArray, writeOptionalStringCollection, writeOptionalText, writeOptionalTimeValue, writeOptionalVInt, writeOptionalVLong, writeOptionalWriteable, writeOptionalZoneId, writeSecureString, writeShort, writeString, writeStringArray, writeStringArrayNullable, writeStringCollection, writeText, writeTimeValue, writeVInt, writeVIntArray, writeVLong, writeVLongArray, 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

Constructor Details

VersionCheckingStreamOutput

public VersionCheckingStreamOutput(Version version)

Method Details

writeByte

public void writeByte(byte b)
               throws IOException

Description copied from class: StreamOutput

Writes a single byte.

Specified by:

writeByte in class StreamOutput

Throws:

IOException

writeBytes

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

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

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from class: StreamOutput

Forces any buffered output to be written.

Specified by:

flush in interface Flushable

Specified by:

flush in class StreamOutput

Throws:

IOException

close

public void close()
           throws IOException

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

Throws:

IOException

reset

public void reset()
           throws IOException

Specified by:

reset in class StreamOutput

Throws:

IOException

writeNamedWriteable

public void writeNamedWriteable(NamedWriteable namedWriteable)
                         throws IOException

Description copied from class: StreamOutput

Writes a NamedWriteable to the current stream, by first writing its name and then the object itself

Overrides:

writeNamedWriteable in class StreamOutput

Throws:

IOException

writeOptionalNamedWriteable

public void writeOptionalNamedWriteable(@Nullable
 NamedWriteable namedWriteable)
                                 throws IOException

Description copied from class: StreamOutput

Write an optional NamedWriteable to the stream.

Overrides:

writeOptionalNamedWriteable in class StreamOutput

Throws:

IOException