net.openhft.chronicle.map

Interface MapEntry<K,V>

Type Parameters:

K - the map key type

V - the map value type

All Superinterfaces:

HashEntry<K>, SetEntry<K>

All Known Implementing Classes:

MapEntryStages, MapQuery, MapSegmentIteration, ReplicatedMapEntryDelegating, ReplicatedMapEntryStages, ReplicatedMapQuery, ReplicatedMapSegmentIteration, SegmentsRecovery

public interface MapEntry<K,V>
extends SetEntry<K>

A context of a present entry in the ChronicleMap.

See Also:

MapEntryOperations, MapQueryContext.entry()

Method Summary

Modifier and Type	Method and Description
MapContext<K,V,?>	context() Returns the context, in which the entry is accessed.
void	doRemove() Removes the entry from the map.
void	doReplaceValue(Data<V> newValue) Replaces the entry's value with the given newValue.
Data<V>	value() Returns the entry value.

Methods inherited from interface net.openhft.chronicle.hash.HashEntry

key

Method Detail

context

@NotNull
MapContext<K,V,?> context()

Description copied from interface: HashEntry

Returns the context, in which the entry is accessed.

Specified by:

context in interface HashEntry<K>

Specified by:

context in interface SetEntry<K>

value

@NotNull
Data<V> value()

Returns the entry value.

doReplaceValue

void doReplaceValue(Data<V> newValue)

Replaces the entry's value with the given newValue.

This method is the default implementation for MapEntryOperations.replaceValue( MapEntry, Data), which might be customized over the default.

Parameters:

newValue - the value to be put into the map instead of the current value

Throws:

IllegalStateException - if some locking/state conditions required to perform replace operation are not met

doRemove

void doRemove()

Removes the entry from the map.

This method is the default implementation for MapEntryOperations.remove(MapEntry), which might be customized over the default.

Specified by:

doRemove in interface HashEntry<K>

Specified by:

doRemove in interface SetEntry<K>