Package org.aeonbits.owner

Class ConfigCache

java.lang.Object

org.aeonbits.owner.ConfigCache

public final class ConfigCache
extends Object

Utility class caching Config instances that can be used as Singletons. This class is designed to be thread safe.

Since:

1.0.6

Author:

Luigi R. Viggiano

Method Summary

Modifier and Type	Method	Description
static <T extends Config> T	add(Object key, T instance)	Adds a Config object into the cache.
static void	clear()	Removes all of the cached instances.
static <T extends Config> T	get(Object key)	Gets from the cache the Config instance identified by the given key.
static <T extends Config> T	getOrCreate(Class<? extends T> clazz, Map<?,?>... imports)	Gets from the cache or create, an instance of the given class using the given imports.
static <T extends Config> T	getOrCreate(Object key, Class<? extends T> clazz, Map<?,?>... imports)	Gets from the cache or create, an instance of the given class using the given imports.
static <T extends Config> T	getOrCreate(Factory factory, Class<? extends T> clazz, Map<?,?>... imports)	Gets from the cache or create, an instance of the given class using the given imports.
static <T extends Config> T	getOrCreate(Factory factory, Object key, Class<? extends T> clazz, Map<?,?>... imports)	Gets from the cache or create, an instance of the given class using the given imports.
static Set<Object>	list()	Lists the key objects for all configuration instances present in the cache.
static <T extends Config> T	remove(Object key)	Removes the cached instance for the given key if it is present.

Methods inherited from class java.lang.Object

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

Method Detail

getOrCreate

public static <T extends Config> T getOrCreate(Class<? extends T> clazz,
                                               Map<?,?>... imports)

Gets from the cache or create, an instance of the given class using the given imports. The factory used to create new instances is the static ConfigFactory.INSTANCE.

Type Parameters:

T - type of the interface.

Parameters:

clazz - the interface extending from Config that you want to instantiate.

imports - additional variables to be used to resolve the properties.

Returns:

an object implementing the given interface, that can be taken from the cache, which maps methods to property values.

getOrCreate

public static <T extends Config> T getOrCreate(Factory factory,
                                               Class<? extends T> clazz,
                                               Map<?,?>... imports)

Gets from the cache or create, an instance of the given class using the given imports.

Type Parameters:

T - type of the interface.

Parameters:

factory - the factory to use to eventually create the instance.

clazz - the interface extending from Config that you want to instantiate.

imports - additional variables to be used to resolve the properties.

Returns:

an object implementing the given interface, that can be taken from the cache, which maps methods to property values.

getOrCreate

public static <T extends Config> T getOrCreate(Object key,
                                               Class<? extends T> clazz,
                                               Map<?,?>... imports)

Gets from the cache or create, an instance of the given class using the given imports. The factory used to create new instances is the static ConfigFactory.INSTANCE.

Type Parameters:

T - type of the interface.

Parameters:

key - the key object to be used to identify the instance in the cache.

clazz - the interface extending from Config that you want to instantiate.

imports - additional variables to be used to resolve the properties.

Returns:

an object implementing the given interface, that can be taken from the cache, which maps methods to property values.

getOrCreate

public static <T extends Config> T getOrCreate(Factory factory,
                                               Object key,
                                               Class<? extends T> clazz,
                                               Map<?,?>... imports)

Gets from the cache or create, an instance of the given class using the given imports.

Type Parameters:

T - type of the interface.

Parameters:

factory - the factory to use to eventually create the instance.

key - the key object to be used to identify the instance in the cache.

clazz - the interface extending from Config that you want to instantiate.

imports - additional variables to be used to resolve the properties.

Returns:

an object implementing the given interface, that can be taken from the cache, which maps methods to property values.

get

public static <T extends Config> T get(Object key)

Gets from the cache the Config instance identified by the given key.

Type Parameters:

T - type of the interface.

Parameters:

key - the key object to be used to identify the instance in the cache.

Returns:

the Config object from the cache if exists, or null if it doesn't.

add

public static <T extends Config> T add(Object key,
                                       T instance)

Adds a Config object into the cache.

Type Parameters:

T - type of the interface.

Parameters:

key - the key object to be used to identify the instance in the cache.

instance - the instance of the Config object to be stored into the cache.

Returns:

the previous value associated with the specified key, or null if there was no mapping for the key.

list

public static Set<Object> list()

Lists the key objects for all configuration instances present in the cache.

Returns:

a set containing the key objects for all instance in the cache.

clear

public static void clear()

Removes all of the cached instances. The cache will be empty after this call returns.

remove

public static <T extends Config> T remove(Object key)

Removes the cached instance for the given key if it is present.

Returns previous instance associated to the given key in the cache, or null if the cache contained no instance for the given key.

The cache will not contain the instance for the specified key once the call returns.

Type Parameters:

T - type of the interface.

Parameters:

key - key whose instance is to be removed from the cache.

Returns:

the previous instance associated with key, or null if there was no instance for key.