Module org.elasticsearch.server

Package org.elasticsearch.cluster

Interface DiffableUtils.ValueSerializer<K,V>

Type Parameters:

K - key type of map

V - value type of map

All Known Implementing Classes:

DiffableUtils.DiffableValueReader, DiffableUtils.DiffableValueSerializer, DiffableUtils.NonDiffableValueSerializer, DiffableUtils.StringSetValueSerializer, NamedDiffableValueSerializer

Enclosing class:

DiffableUtils

public static interface DiffableUtils.ValueSerializer<K,V>

Provides read and write operations to serialize map values. Reading of values can be made dependent on map key. Also provides operations to distinguish whether map values are diffable. Should not be directly implemented, instead implement either DiffableUtils.DiffableValueSerializer or DiffableUtils.NonDiffableValueSerializer.

Method Summary

Modifier and Type	Method	Description
Diff<V>	diff(V value, V beforePart)	Computes diff if this serializer supports diffable values
V	read(StreamInput in, K key)	Reads value from stream.
Diff<V>	readDiff(StreamInput in, K key)	Reads value as diff from stream if this serializer supports diffable values.
boolean	supportsDiffableValues()	Whether this serializer supports diffable values
default boolean	supportsVersion(Diff<V> value, TransportVersion version)	Whether this serializer supports the version of the output stream
default boolean	supportsVersion(V value, TransportVersion version)	Whether this serializer supports the version of the output stream
void	write(V value, StreamOutput out)	Writes value to stream
void	writeDiff(Diff<V> value, StreamOutput out)	Writes value as diff to stream if this serializer supports diffable values

Method Details

write

void write(V value,
 StreamOutput out)
    throws IOException

Writes value to stream

Throws:

IOException

read

V read(StreamInput in,
 K key)
throws IOException

Reads value from stream. Reading operation can be made dependent on map key.

Throws:

IOException

supportsDiffableValues

boolean supportsDiffableValues()

Whether this serializer supports diffable values

supportsVersion

default boolean supportsVersion(Diff<V> value,
 TransportVersion version)

Whether this serializer supports the version of the output stream

supportsVersion

default boolean supportsVersion(V value,
 TransportVersion version)

Whether this serializer supports the version of the output stream

diff

Diff<V> diff(V value,
 V beforePart)

Computes diff if this serializer supports diffable values

writeDiff

void writeDiff(Diff<V> value,
 StreamOutput out)
        throws IOException

Writes value as diff to stream if this serializer supports diffable values

Throws:

IOException

readDiff

Diff<V> readDiff(StreamInput in,
 K key)
          throws IOException

Reads value as diff from stream if this serializer supports diffable values. Reading operation can be made dependent on map key.

Throws:

IOException