org.opendaylight.infrautils.caches

Class BaseCacheConfig

java.lang.Object

org.opendaylight.infrautils.caches.BaseCacheConfig

Direct Known Subclasses:

CacheConfig, CheckedCacheConfig

public abstract class BaseCacheConfig
extends Object

Base class for CacheConfig and CheckedCacheConfig.

Author:

Michael Vorburger.ch

Constructor Summary

Constructors

Constructor and Description
BaseCacheConfig()

Method Summary

Modifier and Type	Method and Description
abstract Object	anchor() Instance of the class "containing" this Cache.
protected void	check() Validates this cache configuration.
String	description() Human readable 1 line description of this Cache.
String	id() Short ID of this Cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseCacheConfig

public BaseCacheConfig()

Method Detail

anchor

public abstract Object anchor()

Instance of the class "containing" this Cache. Used by CacheManagers for display to end-user. Also used under OSGi to close() the cache on bundle unload.

id

@Value.Default
public String id()

Short ID of this Cache. Optional; default is anchor' class name. Recommended if a class has more than one Cache instance. Used only by CacheManagers for display to end-user. Any code requiring to identify a instances would just hold on to the Cache instance. Must be all lower case letters only, may use dot as separator, but no spaces or other characters.

description

@Value.Default
public String description()

Human readable 1 line description of this Cache. Used by CacheManagers for display to end-user. Optional; default is no description.

check

@Value.Check
protected void check()

Validates this cache configuration.