org.onosproject.store.primitives.impl

Class TranscodingAsyncConsistentMultimap<K1,V1,K2,V2>

java.lang.Object

org.onosproject.store.primitives.impl.TranscodingAsyncConsistentMultimap<K1,V1,K2,V2>

Type Parameters:

K2 - key type of other map

V2 - value type of other map

K1 - key type of this map

V1 - value type of this map

All Implemented Interfaces:

AsyncConsistentMultimap<K1,V1>, DistributedPrimitive

public class TranscodingAsyncConsistentMultimap<K1,V1,K2,V2>
extends Object
implements AsyncConsistentMultimap<K1,V1>

An AsyncConsistentMultimap that maps its operation to operations to a differently typed AsyncConsistentMultimap by transcoding operation inputs and outputs while maintaining version numbers.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

DistributedPrimitive.Status, DistributedPrimitive.Type

Field Summary

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
TranscodingAsyncConsistentMultimap(AsyncConsistentMultimap<K2,V2> backingMap, Function<K1,K2> keyEncoder, Function<K2,K1> keyDecoder, Function<V2,V1> valueDecoder, Function<V1,V2> valueEncoder)

Method Summary

Modifier and Type	Method and Description
void	addStatusChangeListener(Consumer<DistributedPrimitive.Status> listener) Registers a listener to be called when the primitive's status changes.
CompletableFuture<Map<K1,Collection<V1>>>	asMap() Returns a map of keys to collections of values that reflect the set of key-value pairs contained in the multimap, where the key value pairs would be the key paired with each of the values in the collection.
CompletableFuture<Void>	clear() Removes all key-value pairs, after which it will be empty.
CompletableFuture<Boolean>	containsEntry(K1 key, V1 value) Returns true if this map contains at least one key-value pair with key and value specified.
CompletableFuture<Boolean>	containsKey(K1 key) Returns true if there is at lease one key-value pair with a key equal to key.
CompletableFuture<Boolean>	containsValue(V1 value) Returns true if this map contains at lease one key-value pair with a value equal to value.
CompletableFuture<Collection<Map.Entry<K1,V1>>>	entries() Returns a collection of each key-value pair in this map.
CompletableFuture<Versioned<Collection<? extends V1>>>	get(K1 key) Returns a collection of values associated with the specified key, if the key is not in the map it will return an empty collection.
CompletableFuture<Boolean>	isEmpty() Returns if this multimap contains no key-value pairs.
CompletableFuture<com.google.common.collect.Multiset<K1>>	keys() Returns a multiset of the keys present in this multimap with one or more associated values each.
CompletableFuture<Set<K1>>	keySet() Returns a set of the keys contained in this multimap with one or more associated values.
String	name() Returns the name of this primitive.
CompletableFuture<Boolean>	put(K1 key, V1 value) If the key-value pair does not already exist adds either the key value pair or the value to the set of values associated with the key and returns true, if the key-value pair already exists then behavior is implementation specific with some implementations allowing duplicates and others ignoring put requests for existing entries.
CompletableFuture<Boolean>	putAll(K1 key, Collection<? extends V1> values) Adds the set of key-value pairs of the specified key with each of the values in the iterable if each key-value pair does not already exist, if the pair does exist the behavior is implementation specific.
CompletableFuture<Boolean>	remove(K1 key, V1 value) Removes the key-value pair with the specified values if it exists.
CompletableFuture<Versioned<Collection<? extends V1>>>	removeAll(K1 key) Removes all values associated with the specified key as well as the key itself.
CompletableFuture<Boolean>	removeAll(K1 key, Collection<? extends V1> values) Removes the key-value pairs with the specified key and values if they exist.
void	removeStatusChangeListener(Consumer<DistributedPrimitive.Status> listener) Unregisters a previously registered listener to be called when the primitive's status changes.
CompletableFuture<Versioned<Collection<? extends V1>>>	replaceValues(K1 key, Collection<V1> values) Stores all the values in values associated with the key specified, removes all preexisting values and returns a collection of the removed values which may be empty if the entry did not exist.
CompletableFuture<Integer>	size() Returns the number of key-value pairs in this multimap.
Collection<Consumer<DistributedPrimitive.Status>>	statusChangeListeners() Returns the collection of status change listeners previously registered.
CompletableFuture<com.google.common.collect.Multiset<V1>>	values() Returns a collection of values in the set with duplicates permitted, the size of this collection will equal the size of the map at the time of creation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.service.AsyncConsistentMultimap

asMultimap, asMultimap, destroy, primitiveType

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

applicationId

Constructor Detail

TranscodingAsyncConsistentMultimap

public TranscodingAsyncConsistentMultimap(AsyncConsistentMultimap<K2,V2> backingMap,
                                          Function<K1,K2> keyEncoder,
                                          Function<K2,K1> keyDecoder,
                                          Function<V2,V1> valueDecoder,
                                          Function<V1,V2> valueEncoder)

Method Detail

size

public CompletableFuture<Integer> size()

Description copied from interface: AsyncConsistentMultimap

Returns the number of key-value pairs in this multimap.

Specified by:

size in interface AsyncConsistentMultimap<K1,V1>

Returns:

the number of key-value pairs

isEmpty

public CompletableFuture<Boolean> isEmpty()

Description copied from interface: AsyncConsistentMultimap

Returns if this multimap contains no key-value pairs.

Specified by:

isEmpty in interface AsyncConsistentMultimap<K1,V1>

Returns:

completable future that will be true if no key-value pairs exist, false otherwise

containsKey

public CompletableFuture<Boolean> containsKey(K1 key)

Description copied from interface: AsyncConsistentMultimap

Returns true if there is at lease one key-value pair with a key equal to key.

Specified by:

containsKey in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key to query

Returns:

a future whose value will be true if the map contains a key-value pair with key false otherwise

containsValue

public CompletableFuture<Boolean> containsValue(V1 value)

Description copied from interface: AsyncConsistentMultimap

Returns true if this map contains at lease one key-value pair with a value equal to value.

Specified by:

containsValue in interface AsyncConsistentMultimap<K1,V1>

Parameters:

value - the value to query

Returns:

a future whose value will be true if there is a key-value pair with the specified value, false otherwise.

containsEntry

public CompletableFuture<Boolean> containsEntry(K1 key,
                                                V1 value)

Description copied from interface: AsyncConsistentMultimap

Returns true if this map contains at least one key-value pair with key and value specified.

Specified by:

containsEntry in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - key

value - value

Returns:

a future whose value will be true if there is a key-value pair with the specified key and value, false otherwise.

put

public CompletableFuture<Boolean> put(K1 key,
                                      V1 value)

Description copied from interface: AsyncConsistentMultimap

If the key-value pair does not already exist adds either the key value pair or the value to the set of values associated with the key and returns true, if the key-value pair already exists then behavior is implementation specific with some implementations allowing duplicates and others ignoring put requests for existing entries.

Specified by:

put in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key to add

value - the value to add

Returns:

a future whose value will be true if the map has changed because of this call, false otherwise

remove

public CompletableFuture<Boolean> remove(K1 key,
                                         V1 value)

Description copied from interface: AsyncConsistentMultimap

Removes the key-value pair with the specified values if it exists. In implementations that allow duplicates which matching entry will be removed is undefined.

Specified by:

remove in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key of the pair to be removed

value - the value of the pair to be removed

Returns:

a future whose value will be true if the map changed because of this call, false otherwise.

removeAll

public CompletableFuture<Boolean> removeAll(K1 key,
                                            Collection<? extends V1> values)

Description copied from interface: AsyncConsistentMultimap

Removes the key-value pairs with the specified key and values if they exist. In implementations that allow duplicates each instance of a key will remove one matching entry, which one is not defined. Equivalent to repeated calls to remove() for each key value pair but more efficient.

Specified by:

removeAll in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key of the pair to be removed

values - the set of values to be removed

Returns:

a future whose value will be true if the map changes because of this call, false otherwise.

removeAll

public CompletableFuture<Versioned<Collection<? extends V1>>> removeAll(K1 key)

Description copied from interface: AsyncConsistentMultimap

Removes all values associated with the specified key as well as the key itself.

Specified by:

removeAll in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key whose key-value pairs will be removed

Returns:

a future whose value is the set of values that were removed, which may be empty, if the values did not exist the version will be less than one.

putAll

public CompletableFuture<Boolean> putAll(K1 key,
                                         Collection<? extends V1> values)

Description copied from interface: AsyncConsistentMultimap

Adds the set of key-value pairs of the specified key with each of the values in the iterable if each key-value pair does not already exist, if the pair does exist the behavior is implementation specific. (Same as repeated puts but with efficiency gains.)

Specified by:

putAll in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key to use for all pairs to be added

values - the set of values to be added in pairs with the key

Returns:

a future whose value will be true if any change in the map results from this call, false otherwise

replaceValues

public CompletableFuture<Versioned<Collection<? extends V1>>> replaceValues(K1 key,
                                                                            Collection<V1> values)

Description copied from interface: AsyncConsistentMultimap

Stores all the values in values associated with the key specified, removes all preexisting values and returns a collection of the removed values which may be empty if the entry did not exist.

Specified by:

replaceValues in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key for all entries to be added

values - the values to be associated with the key

Returns:

a future whose value will be the collection of removed values, which may be empty

clear

public CompletableFuture<Void> clear()

Description copied from interface: AsyncConsistentMultimap

Removes all key-value pairs, after which it will be empty.

Specified by:

clear in interface AsyncConsistentMultimap<K1,V1>

Returns:

a future whose value is irrelevant, simply used to determine if the call has completed

get

public CompletableFuture<Versioned<Collection<? extends V1>>> get(K1 key)

Description copied from interface: AsyncConsistentMultimap

Returns a collection of values associated with the specified key, if the key is not in the map it will return an empty collection.

Specified by:

get in interface AsyncConsistentMultimap<K1,V1>

Parameters:

key - the key whose associated values will be returned

Returns:

a future whose value will be the collection of the values associated with the specified key, the collection may be empty

keySet

public CompletableFuture<Set<K1>> keySet()

Description copied from interface: AsyncConsistentMultimap

Returns a set of the keys contained in this multimap with one or more associated values.

Specified by:

keySet in interface AsyncConsistentMultimap<K1,V1>

Returns:

a future whose value will be the collection of all keys with one or more associated values, this may be empty

keys

public CompletableFuture<com.google.common.collect.Multiset<K1>> keys()

Description copied from interface: AsyncConsistentMultimap

Returns a multiset of the keys present in this multimap with one or more associated values each. Keys will appear once for each key-value pair in which they participate.

Specified by:

keys in interface AsyncConsistentMultimap<K1,V1>

Returns:

a future whose value will be a multiset of the keys, this may be empty

values

public CompletableFuture<com.google.common.collect.Multiset<V1>> values()

Description copied from interface: AsyncConsistentMultimap

Returns a collection of values in the set with duplicates permitted, the size of this collection will equal the size of the map at the time of creation.

Specified by:

values in interface AsyncConsistentMultimap<K1,V1>

Returns:

a future whose value will be a collection of values, this may be empty

entries

public CompletableFuture<Collection<Map.Entry<K1,V1>>> entries()

Description copied from interface: AsyncConsistentMultimap

Returns a collection of each key-value pair in this map.

Specified by:

entries in interface AsyncConsistentMultimap<K1,V1>

Returns:

a future whose value will be a collection of all entries in the map, this may be empty

asMap

public CompletableFuture<Map<K1,Collection<V1>>> asMap()

Description copied from interface: AsyncConsistentMultimap

Returns a map of keys to collections of values that reflect the set of key-value pairs contained in the multimap, where the key value pairs would be the key paired with each of the values in the collection.

Specified by:

asMap in interface AsyncConsistentMultimap<K1,V1>

Returns:

a future whose value will be a map of keys to collections of values, the returned map may be empty.

name

public String name()

Description copied from interface: DistributedPrimitive

Returns the name of this primitive.

Specified by:

name in interface DistributedPrimitive

Returns:

name

addStatusChangeListener

public void addStatusChangeListener(Consumer<DistributedPrimitive.Status> listener)

Description copied from interface: DistributedPrimitive

Registers a listener to be called when the primitive's status changes.

Specified by:

addStatusChangeListener in interface DistributedPrimitive

Parameters:

listener - The listener to be called when the status changes.

removeStatusChangeListener

public void removeStatusChangeListener(Consumer<DistributedPrimitive.Status> listener)

Description copied from interface: DistributedPrimitive

Unregisters a previously registered listener to be called when the primitive's status changes.

Specified by:

removeStatusChangeListener in interface DistributedPrimitive

Parameters:

listener - The listener to unregister

statusChangeListeners

public Collection<Consumer<DistributedPrimitive.Status>> statusChangeListeners()

Description copied from interface: DistributedPrimitive

Returns the collection of status change listeners previously registered.

Specified by:

statusChangeListeners in interface DistributedPrimitive

Returns:

collection of status change listeners