org.onosproject.store.service.impl

Class CMap<K,V>

java.lang.Object

org.onosproject.store.service.impl.CMap<K,V>

Type Parameters:

K - Key type of the map. The type must have toString(), which can uniquely identify the entry.

V - Value type

public class CMap<K,V>
extends Object

Map like interface wrapper around DatabaseService.

Constructor Summary

Constructors

Constructor and Description
CMap(org.onosproject.store.service.DatabaseAdminService dbAdminService, org.onosproject.store.service.DatabaseService dbService, String tableName, org.onosproject.store.serializers.StoreSerializer serializer) Creates a CMap instance.

Method Summary

Modifier and Type	Method and Description
protected V	dV(byte[] valBytes)
V	get(K key) Gets the value in the map.
V	put(K key, V value) Puts a value int the map.
boolean	putIfAbsent(K key, V value) Puts an entry to the map, if not already present.
V	remove(K key) Removes an entry associated to specified key.
boolean	replace(K key, V oldVal, V newVal) Replaces the value in the map if the value matches the expected.
long	size() Returns the size of the map.
protected String	sK(K key)
protected byte[]	sV(V val)
Iterable<V>	values() Returns all the values contained in the map.

Methods inherited from class java.lang.Object

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

Constructor Detail

CMap

public CMap(org.onosproject.store.service.DatabaseAdminService dbAdminService,
            org.onosproject.store.service.DatabaseService dbService,
            String tableName,
            org.onosproject.store.serializers.StoreSerializer serializer)

Creates a CMap instance. It will create the table if necessary.

Parameters:

dbAdminService - DatabaseAdminService to use for this instance

dbService - DatabaseService to use for this instance

tableName - table which this Map corresponds to

serializer - Value serializer

Method Detail

sK

protected String sK(K key)

sV

protected byte[] sV(V val)

dV

protected V dV(byte[] valBytes)

putIfAbsent

public boolean putIfAbsent(K key,
                           V value)

Puts an entry to the map, if not already present.

Parameters:

key - the key of the value to put if absent

value - the value to be put if previous value does not exist

Returns:

true if put was successful.

remove

public V remove(K key)

Removes an entry associated to specified key.

Parameters:

key - key of the value to remove

Returns:

previous value in the map for the key

size

public long size()

Returns the size of the map.

Returns:

size of the map

values

public Iterable<V> values()

Returns all the values contained in the map.

Returns:

values containd in this map

get

public V get(K key)

Gets the value in the map.

Parameters:

key - to get from the map

Returns:

value associated with the key, null if not such entry

replace

public boolean replace(K key,
                       V oldVal,
                       V newVal)

Replaces the value in the map if the value matches the expected.

Parameters:

key - of the entry to replace

oldVal - value expected to be in the map

newVal - value to be replaced with

Returns:

true if successfully replaced

put

public V put(K key,
             V value)

Puts a value int the map.

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

previous value or null if not such entry