Package org.elasticsearch.common.io.stream

Class NamedWriteableAwareStreamInput

java.lang.Object

java.io.InputStream

org.elasticsearch.common.io.stream.StreamInput

org.elasticsearch.common.io.stream.FilterStreamInput

org.elasticsearch.common.io.stream.NamedWriteableAwareStreamInput

All Implemented Interfaces:

Closeable, AutoCloseable

public class NamedWriteableAwareStreamInput
extends FilterStreamInput

Wraps a StreamInput and associates it with a NamedWriteableRegistry

Field Summary

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

delegate

Constructor Summary

Constructors

Constructor	Description
NamedWriteableAwareStreamInput(StreamInput delegate, NamedWriteableRegistry namedWriteableRegistry)

Method Summary

Modifier and Type	Method	Description
NamedWriteableRegistry	namedWriteableRegistry()	Get the registry of named writeables if this stream has one, null otherwise.
<C extends NamedWriteable> C	readNamedWriteable(Class<C> categoryClass)	Reads a NamedWriteable from the current stream, by first reading its name and then looking for the corresponding entry in the registry by name, so that the proper object can be read and returned.
<C extends NamedWriteable> C	readNamedWriteable(Class<C> categoryClass, String name)	Reads a NamedWriteable from the current stream with the given name.

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

available, close, ensureCanReadBytes, getVersion, read, readByte, readBytes, readInt, readLong, readReleasableBytesReference, readShort, readVInt, readVLong, reset, setVersion

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

readArray, readArraySize, readBigInteger, readBoolean, readByteArray, readBytesRef, readBytesRef, readBytesReference, readBytesReference, readDouble, readDoubleArray, readEnum, readEnumSet, readException, readFloat, readFloatArray, readFully, readGenericValue, readGeoPoint, readImmutableMap, readInstant, readIntArray, readList, readLongArray, readMap, readMap, readMapOfLists, readNamedWriteableList, readOptionalArray, readOptionalBoolean, readOptionalBytesReference, readOptionalDouble, readOptionalEnum, readOptionalFloat, readOptionalInstant, readOptionalInt, readOptionalLong, readOptionalNamedWriteable, readOptionalSecureString, readOptionalString, readOptionalStringArray, readOptionalStringList, readOptionalText, readOptionalTimeValue, readOptionalTimeZone, readOptionalVInt, readOptionalVLong, readOptionalWriteable, readOptionalZoneId, readOrderedMap, readSecureString, readSet, readString, readStringArray, readStringList, readText, readTimeValue, readTimeZone, readVIntArray, readVIntSlow, readVLongArray, readVLongSlow, readZLong, readZoneId, throwOnBrokenVInt, throwOnBrokenVLong, wrap, wrap

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

NamedWriteableAwareStreamInput

public NamedWriteableAwareStreamInput(StreamInput delegate,
 NamedWriteableRegistry namedWriteableRegistry)

Method Details

readNamedWriteable

public <C extends NamedWriteable> C readNamedWriteable(Class<C> categoryClass)
                                                throws IOException

Description copied from class: StreamInput

Reads a NamedWriteable from the current stream, by first reading its name and then looking for the corresponding entry in the registry by name, so that the proper object can be read and returned. Default implementation throws UnsupportedOperationException as StreamInput doesn't hold a registry. Use FilterInputStream instead which wraps a stream and supports a NamedWriteableRegistry too.

Overrides:

readNamedWriteable in class StreamInput

Throws:

IOException

readNamedWriteable

public <C extends NamedWriteable> C readNamedWriteable(Class<C> categoryClass,
 String name)
                                                throws IOException

Description copied from class: StreamInput

Reads a NamedWriteable from the current stream with the given name. It is assumed that the caller obtained the name from other source, so it's not read from the stream. The name is used for looking for the corresponding entry in the registry by name, so that the proper object can be read and returned. Default implementation throws UnsupportedOperationException as StreamInput doesn't hold a registry. Use FilterInputStream instead which wraps a stream and supports a NamedWriteableRegistry too. Prefer StreamInput.readNamedWriteable(Class) and StreamOutput.writeNamedWriteable(NamedWriteable) unless you have a compelling reason to use this method instead.

Overrides:

readNamedWriteable in class StreamInput

Throws:

IOException

namedWriteableRegistry

public NamedWriteableRegistry namedWriteableRegistry()

Description copied from class: StreamInput

Get the registry of named writeables if this stream has one, null otherwise.

Overrides:

namedWriteableRegistry in class FilterStreamInput