org.opendaylight.vtn.manager.internal.util

Class CacheMap<T,K,C>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.CacheMap<T,K,C>

Type Parameters:

T - The type of the raw data.

K - The type of key that specifies data.

C - The type of the cache for the raw data.

All Implemented Interfaces:

Iterable<C>

public abstract class CacheMap<T,K,C>
extends Object
implements Iterable<C>

CacheMap describes a lazy cache for data indexed by a key.

This class is used to cache YANG data objects in a keyed list. A cache for list element is instantiated on the first access to it.

• Note that this class is not synchronized.
• The size of the list cannot be changed.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CacheMap(List<T> list) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Collection<C>	cachedValues() Return a collection of cached data.
C	get(K key) Return the cache for the object associated with the given key.
C	getCached(K key) Return the cached data associated with the given key.
protected abstract K	getKey(T data) Return a key in the given raw data.
Iterator<C>	iterator() Return an iterator over a set of cached data.
protected abstract C	newCache(T data) Create a new cached data.
C	put(K key, C value) Associate the given cache with the given key in this instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CacheMap

protected CacheMap(List<T> list)

Construct a new instance.

Parameters:

list - A list of raw data. Note that the caller must not modify this list.

Method Detail

get

public final C get(K key)

Return the cache for the object associated with the given key.

Parameters:

key - A key that specifies data.

Returns:

A cached data if found. null if not found.

getCached

public final C getCached(K key)

Return the cached data associated with the given key.

Parameters:

key - A key that specifies data.

Returns:

A cached data if cached. null if not cached.

put

public final C put(K key,
                   C value)

Associate the given cache with the given key in this instance.

Parameters:

key - A key that specifies data. Note that the key must be contained in the raw data list passed to constructor.

value - A new cache for data specified by key.

Returns:

If the give key is contained by this instance, a cached data associated with the given key is returned. Otherwise cache is returned.

cachedValues

public final Collection<C> cachedValues()

Return a collection of cached data.

Returns:

A collection of cached data.

getKey

protected abstract K getKey(T data)

Return a key in the given raw data.

Parameters:

data - A raw data.

Returns:

A key for the given data.

newCache

protected abstract C newCache(T data)

Create a new cached data.

Parameters:

data - A raw data.

Returns:

A cached data for the given data.

iterator

public Iterator<C> iterator()

Return an iterator over a set of cached data.

Specified by:

iterator in interface Iterable<C>

Returns:

An iterator for cached data.