Package org.opensearch.cluster
Interface DiffableUtils.ValueSerializer<K,V>
- Type Parameters:
K
- key type of mapV
- 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
.
- Opensearch.internal:
-
Method Summary
Modifier and TypeMethodDescriptionComputes diff if this serializer supports diffable valuesReads value from stream.Reads value as diff from stream if this serializer supports diffable values.boolean
Whether this serializer supports diffable valuesdefault boolean
supportsVersion
(Diff<V> value, org.opensearch.Version version) Whether this serializer supports the version of the output streamdefault boolean
supportsVersion
(V value, org.opensearch.Version version) Whether this serializer supports the version of the output streamvoid
Writes value to streamvoid
Writes value as diff to stream if this serializer supports diffable values
-
Method Details
-
write
Writes value to stream- Throws:
IOException
-
read
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
Whether this serializer supports the version of the output stream -
supportsVersion
Whether this serializer supports the version of the output stream -
diff
Computes diff if this serializer supports diffable values -
writeDiff
void writeDiff(Diff<V> value, org.opensearch.core.common.io.stream.StreamOutput out) throws IOException Writes value as diff to stream if this serializer supports diffable values- Throws:
IOException
-
readDiff
Reads value as diff from stream if this serializer supports diffable values. Reading operation can be made dependent on map key.- Throws:
IOException
-