Class BaseCacheConfig
- java.lang.Object
-
- org.opendaylight.infrautils.caches.BaseCacheConfig
-
- Direct Known Subclasses:
CacheConfig
,CheckedCacheConfig
public abstract class BaseCacheConfig extends Object
Base class forCacheConfig
andCheckedCacheConfig
.- Author:
- Michael Vorburger.ch
-
-
Constructor Summary
Constructors Constructor Description BaseCacheConfig()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Method Detail
-
anchor
public abstract Object anchor()
Instance of the class "containing" this Cache. Used byCacheManagers
for display to end-user. Also used under OSGi to close() the cache on bundle unload.
-
id
@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 byCacheManagers
for display to end-user. Any code requiring to identify a instances would just hold on to theCache
instance. Must be all lower case letters only, may use dot as separator, but no spaces or other characters.
-
description
@Default public String description()
Human readable 1 line description of this Cache. Used byCacheManagers
for display to end-user. Optional; default is no description.
-
check
@Check protected void check()
Validates this cache configuration.
-
-