org.opendaylight.genius.mdsalutil.cache

Class DataObjectCache<K,V extends org.opendaylight.yangtools.yang.binding.DataObject>

java.lang.Object

org.opendaylight.genius.mdsalutil.cache.DataObjectCache<K,V>

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

DpnTepStateCache, IfIndexInterfaceCache, InstanceIdDataObjectCache, OvsBridgeEntryCache, OvsBridgeRefEntryCache

public class DataObjectCache<K,V extends org.opendaylight.yangtools.yang.binding.DataObject>
extends Object
implements AutoCloseable

Caches DataObjects of a particular type. The cache is updated by a DataTreeChangeListener.

Author:

Thomas Pantelis

Constructor Summary

Constructors

Constructor and Description

DataObjectCache(Class<V> dataObjectClass, org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker, org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V> listenerRegistrationPath, org.opendaylight.infrautils.caches.CacheProvider cacheProvider, BiFunction<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V>,V,K> keyFunction, Function<K,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V>> instanceIdFunction) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	added(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V> path, V dataObject)
protected void	checkIsClosed()
void	close()
com.google.common.base.Optional<V>	get(K key) Gets the DataObject for the given key.
Collection<V>	getAllPresent() Gets all DataObjects currently in the cache.
protected void	removed(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V> path, V dataObject)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataObjectCache

public DataObjectCache(Class<V> dataObjectClass,
                       org.opendaylight.controller.md.sal.binding.api.DataBroker dataBroker,
                       org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType datastoreType,
                       org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V> listenerRegistrationPath,
                       org.opendaylight.infrautils.caches.CacheProvider cacheProvider,
                       BiFunction<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V>,V,K> keyFunction,
                       Function<K,org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V>> instanceIdFunction)

Constructor.

Parameters:

dataObjectClass - the DataObject class to cache

dataBroker - the DataBroker

datastoreType - the LogicalDatastoreType

listenerRegistrationPath - the yang path for which register the listener

cacheProvider - the CacheProvider used to instantiate the Cache

keyFunction - the function used to convert or extract the key instance on change notification

instanceIdFunction - the function used to convert a key instance to an InstanceIdentifier on read

Method Detail

close

@PreDestroy
public void close()

Specified by:

close in interface AutoCloseable

checkIsClosed

protected void checkIsClosed()
                      throws org.opendaylight.controller.md.sal.common.api.data.ReadFailedException

Throws:

org.opendaylight.controller.md.sal.common.api.data.ReadFailedException

get

@Nonnull
public com.google.common.base.Optional<V> get(@Nonnull
                                                       K key)
                                                throws org.opendaylight.controller.md.sal.common.api.data.ReadFailedException

Gets the DataObject for the given key. If there's no DataObject cached, it will be read from the data store and put in the cache if it exists.

Parameters:

key - identifies the DataObject to query

Returns:

if the data for the supplied key exists, returns an Optional object containing the data; otherwise, returns Optional#absent()

Throws:

org.opendaylight.controller.md.sal.common.api.data.ReadFailedException - if that data isn't cached and the read to fetch it fails

getAllPresent

@Nonnull
public Collection<V> getAllPresent()

Gets all DataObjects currently in the cache.

Returns:

the DataObjects currently in the cache

added

protected void added(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V> path,
                     V dataObject)

removed

protected void removed(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<V> path,
                       V dataObject)