Package org.opensearch.cluster

Class DiffableUtils.MapDiff<K,T,M>

java.lang.Object

org.opensearch.cluster.DiffableUtils.MapDiff<K,T,M>

Type Parameters:

K - the type of map keys

T - the type of map values

M - the map implementation type

All Implemented Interfaces:

Diff<M>, org.opensearch.core.common.io.stream.Writeable

Enclosing class:

DiffableUtils

public abstract static class DiffableUtils.MapDiff<K,T,M>
extends Object
implements Diff<M>

Represents differences between two maps of objects and is used as base class for different map implementations.

Implements serialization. How differences are applied is left to subclasses.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<K>	deletes
protected final Map<K,Diff<T>>	diffs
protected final DiffableUtils.KeySerializer<K>	keySerializer
protected final Map<K,T>	upserts
protected final DiffableUtils.ValueSerializer<K,T>	valueSerializer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MapDiff(DiffableUtils.KeySerializer<K> keySerializer, DiffableUtils.ValueSerializer<K,T> valueSerializer)
protected	MapDiff(DiffableUtils.KeySerializer<K> keySerializer, DiffableUtils.ValueSerializer<K,T> valueSerializer, List<K> deletes, Map<K,Diff<T>> diffs, Map<K,T> upserts)
protected	MapDiff(org.opensearch.core.common.io.stream.StreamInput in, DiffableUtils.KeySerializer<K> keySerializer, DiffableUtils.ValueSerializer<K,T> valueSerializer)

Method Summary

Modifier and Type	Method	Description
List<K>	getDeletes()	The keys that, when this diff is applied to a map, should be removed from the map.
Map<K,Diff<T>>	getDiffs()	Map entries that, when this diff is applied to a map, should be incrementally updated.
Map<K,T>	getUpserts()	Map entries that, when this diff is applied to a map, should be added to the map or fully replace the previous value.
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.cluster.Diff

apply

Field Details

deletes

protected final List<K> deletes

diffs

protected final Map<K,Diff<T>> diffs

upserts

protected final Map<K,T> upserts

keySerializer

protected final DiffableUtils.KeySerializer<K> keySerializer

valueSerializer

protected final DiffableUtils.ValueSerializer<K,T> valueSerializer

Constructor Details

MapDiff

protected MapDiff(DiffableUtils.KeySerializer<K> keySerializer,
 DiffableUtils.ValueSerializer<K,T> valueSerializer)

MapDiff

protected MapDiff(DiffableUtils.KeySerializer<K> keySerializer,
 DiffableUtils.ValueSerializer<K,T> valueSerializer,
 List<K> deletes,
 Map<K,Diff<T>> diffs,
 Map<K,T> upserts)

MapDiff

protected MapDiff(org.opensearch.core.common.io.stream.StreamInput in,
 DiffableUtils.KeySerializer<K> keySerializer,
 DiffableUtils.ValueSerializer<K,T> valueSerializer)
           throws IOException

Throws:

IOException

Method Details

getDeletes

public List<K> getDeletes()

The keys that, when this diff is applied to a map, should be removed from the map.

Returns:

the list of keys that are deleted

getDiffs

public Map<K,Diff<T>> getDiffs()

Map entries that, when this diff is applied to a map, should be incrementally updated. The incremental update is represented using the Diff interface.

Returns:

the map entries that are incrementally updated

getUpserts

public Map<K,T> getUpserts()

Map entries that, when this diff is applied to a map, should be added to the map or fully replace the previous value.

Returns:

the map entries that are additions or full updates

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException