org.onosproject.store.primitives.resources.impl

Class MapEntryUpdateResult<K,V>

java.lang.Object

org.onosproject.store.primitives.resources.impl.MapEntryUpdateResult<K,V>

Type Parameters:

K - key type

V - result type

public class MapEntryUpdateResult<K,V>
extends Object

Result of a map entry update operation.

Both old and new values are accessible along with a flag that indicates if the the value was updated. If flag is false, oldValue and newValue both point to the same unmodified value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapEntryUpdateResult.Status

Constructor Summary

Constructors

Constructor and Description
MapEntryUpdateResult(MapEntryUpdateResult.Status status, String mapName, K key, Versioned<V> oldValue, Versioned<V> newValue)

Method Summary

Modifier and Type	Method and Description
K	key() Returns the map key.
<K1,V1> MapEntryUpdateResult<K1,V1>	map(Function<K,K1> keyTransform, Function<V,V1> valueMapper) Maps to another instance with different key and value types.
String	mapName() Returns the map name.
Versioned<V>	newValue() Returns the new value after update.
Versioned<V>	oldValue() Returns the old value.
MapEntryUpdateResult.Status	status() Returns the update status.
MapEvent<K,V>	toMapEvent() Return the map event that will be generated as a result of this update.
String	toString()
boolean	updated() Returns true if the update was successful.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapEntryUpdateResult

public MapEntryUpdateResult(MapEntryUpdateResult.Status status,
                            String mapName,
                            K key,
                            Versioned<V> oldValue,
                            Versioned<V> newValue)

Method Detail

updated

public boolean updated()

Returns true if the update was successful.

Returns:

true if yes, false otherwise

mapName

public String mapName()

Returns the map name.

Returns:

map name

status

public MapEntryUpdateResult.Status status()

Returns the update status.

Returns:

update status

key

public K key()

Returns the map key.

Returns:

key

oldValue

public Versioned<V> oldValue()

Returns the old value.

Returns:

the previous value associated with key if updated was successful, otherwise current value

newValue

public Versioned<V> newValue()

Returns the new value after update.

Returns:

if updated was unsuccessful, this is same as old value

map

public <K1,V1> MapEntryUpdateResult<K1,V1> map(Function<K,K1> keyTransform,
                                               Function<V,V1> valueMapper)

Maps to another instance with different key and value types.

Type Parameters:

K1 - key type of returned MapEntryUpdateResult

V1 - value type of returned MapEntryUpdateResult

Parameters:

keyTransform - transformer to use for transcoding keys

valueMapper - mapper to use for transcoding values

Returns:

new instance

toMapEvent

public MapEvent<K,V> toMapEvent()

Return the map event that will be generated as a result of this update.

Returns:

map event. if update was unsuccessful, this returns null

toString

public String toString()

Overrides:

toString in class Object