ObjectCache (Technia Value Components (2024.5.0) API Documentation

java.lang.Object
- com.technia.tvc.core.util.ObjectCache<K,V>

```
public class ObjectCache<K,V>
extends java.lang.Object
```
Implements a simple object cache where the behaviour of a specific named instance can be configured through system properties.
Use the ObjectCache(String) constructor to create a named instance. The cache type can then be configured with a property named tvc.core.util.cache.NAME, where name is the name of the cache. Alternatively it's possible to define the default cache type using the tvc.core.util.cache property. The accepted values for these properties are NONE, SOFT, and STRONG. The default type will be STRONG unless the default type has been configured to something else.
Here is a short description on the available types:
- NONE - Objects will not be cached.
- SOFT - Objects will be cached using soft references.
- STRONG - Objects will be cached using strong (actual) references.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`NONE` No objects will be cached when using this type.
`static int`	`SOFT` Objects will be cached using soft references.
`static int`	`STRONG` Objects will be cached using strong references.

Constructor Summary

Constructors
Constructor and Description
`ObjectCache()` No argument constructor.
`ObjectCache(int type)` Creates a cache of the specified type.
`ObjectCache(int type, ObjectCacheListener listener)` Creates a cache of the specified type.
`ObjectCache(ObjectCacheListener listener)`
`ObjectCache(java.lang.String name)` Creates a cache with the specified name.
`ObjectCache(java.lang.String name, int def)` Creates a cache with the specified name.
`ObjectCache(java.lang.String name, int def, ObjectCacheListener listener)` Creates a cache with the specified name.
`ObjectCache(java.lang.String name, ObjectCacheListener listener)` Creates a cache with the specified name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListener(ObjectCacheListener listener)`
`void`	`clear()` Clears the cache.
`static boolean`	`clear(java.lang.String name)` Clears a cache.
`static void`	`clearAll()` Clear all cache instances.
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`boolean`	`equal(java.lang.Object o)` Compares the objects and returns true if they are equal.
`V`	`get(java.lang.Object key)` Returns the object cached using the specified key.
`static java.util.Iterator<ObjectCache<?,?>>`	`getAll()` Returns an iterator containing all ObjectCache instances
`static ObjectCache<?,?>`	`getById(int id)`
`int`	`getId()`
`java.util.Set<K>`	`getKeys()`
`java.lang.String`	`getName()` Returns the name of the cache, if one was specified in the `constructor`.
`int`	`getType()` Returns the type.
`int`	`hashCode()` Returns the objects hash code.
`boolean`	`isEmpty()`
`boolean`	`isNone()` Returns `true` if the type is equal to `NONE`.
`boolean`	`isSoft()` Returns `true` if the type is equal to `SOFT`.
`boolean`	`isStrong()` Returns `true` if the type is equal to `STRONG`.
`java.util.Map<K,V>`	`map()` Returns the internal `Map`.
`protected java.lang.String`	`paramString()` Returns a parameterized string containing debug information about the object current state.
`V`	`remove(java.lang.Object key)` Removes an item from the cache.
`void`	`set(K key, V value)` Sets the value in the cache associated with the specified key.
`int`	`size()` Returns the number of objects in the cache.
`java.lang.String`	`toString()` Returns a string representation of the object containing debug information about it's current state.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE
```
public static final int NONE
```
    No objects will be cached when using this type.
    
    See Also:
    
    getType(), isNone(), Constant Field Values
  - SOFT
```
public static final int SOFT
```
    Objects will be cached using soft references.
    
    See Also:
    
    getType(), isSoft(), Constant Field Values
  - STRONG
```
public static final int STRONG
```
    Objects will be cached using strong references.
    
    See Also:
    
    getType(), isStrong(), Constant Field Values
- Constructor Detail
  - ObjectCache
```
public ObjectCache()
```
    No argument constructor.
  - ObjectCache
```
public ObjectCache(ObjectCacheListener listener)
```
    Parameters:
    
    listener - A custom listner
    
    Since:
    
    6.1.5
  - ObjectCache
```
public ObjectCache(java.lang.String name)
```
    Creates a cache with the specified name.
  - ObjectCache
```
public ObjectCache(java.lang.String name,
                   ObjectCacheListener listener)
```
    Creates a cache with the specified name.
    
    Since:
    
    6.1.5
  - ObjectCache
```
public ObjectCache(int type)
```
    Creates a cache of the specified type.
  - ObjectCache
```
public ObjectCache(int type,
                   ObjectCacheListener listener)
```
    Creates a cache of the specified type.
    
    Since:
    
    6.1.5
  - ObjectCache
```
public ObjectCache(java.lang.String name,
                   int def)
```
    Creates a cache with the specified name.
    
    Parameters:
    
    name - The name of the cache.
    
    def - The default type.
  - ObjectCache
```
public ObjectCache(java.lang.String name,
                   int def,
                   ObjectCacheListener listener)
```
    Creates a cache with the specified name.
    
    Parameters:
    
    name - The name of the cache.
    
    def - The default type.
    
    listener - The listener.
    
    Since:
    
    6.1.5
- Method Detail
  - addListener
```
public void addListener(ObjectCacheListener listener)
```
  - getId
```
public int getId()
```
  - map
```
public java.util.Map<K,V> map()
```
    Returns the internal Map.
  - getType
```
public int getType()
```
    Returns the type.
  - isNone
```
public boolean isNone()
```
    Returns true if the type is equal to NONE.
  - isSoft
```
public boolean isSoft()
```
    Returns true if the type is equal to SOFT.
  - isStrong
```
public boolean isStrong()
```
    Returns true if the type is equal to STRONG.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the cache, if one was specified in the constructor.
  - get
```
public V get(java.lang.Object key)
```
    Returns the object cached using the specified key.
  - set
```
public void set(K key,
                V value)
```
    Sets the value in the cache associated with the specified key.
  - remove
```
public V remove(java.lang.Object key)
```
    Removes an item from the cache.
    
    Parameters:
    
    key - The key of the item to remove from the cache.
    
    Since:
    
    6.0.0
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Parameters:
    
    key - The key
    
    Returns:
    
    True if the key exists in this cache.
    
    Since:
    
    6.1.7
  - getKeys
```
public java.util.Set<K> getKeys()
```
    Returns:
    
    A list of all keys in the cache
    
    Since:
    
    2020.3.0
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Parameters:
    
    value - The value to check
    
    Returns:
    
    True if the value is part of the cache.
    
    Since:
    
    6.1.7
  - isEmpty
```
public boolean isEmpty()
```
  - size
```
public int size()
```
    Returns the number of objects in the cache.
  - clear
```
public void clear()
```
    Clears the cache.
  - getById
```
public static ObjectCache<?,?> getById(int id)
```
  - getAll
```
public static java.util.Iterator<ObjectCache<?,?>> getAll()
```
    Returns an iterator containing all ObjectCache instances
  - clearAll
```
public static void clearAll()
```
    Clear all cache instances.
  - clear
```
public static boolean clear(java.lang.String name)
```
    Clears a cache.
    
    Parameters:
    
    name - The name of the cache to clear
    
    Returns:
    
    true if the cache was cleared.
    
    Since:
    
    6.4.2
  - hashCode
```
public int hashCode()
```
    Returns the objects hash code.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - equal
```
public boolean equal(java.lang.Object o)
```
    Compares the objects and returns true if they are equal.
  - paramString
```
protected java.lang.String paramString()
```
    Returns a parameterized string containing debug information about the object current state.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the object containing debug information about it's current state.
    
    Overrides:
    
    toString in class java.lang.Object

Class ObjectCache<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

SOFT

STRONG

Constructor Detail

ObjectCache

ObjectCache

ObjectCache

ObjectCache

ObjectCache

ObjectCache

ObjectCache

ObjectCache

Method Detail

addListener

getId

map

getType

isNone

isSoft

isStrong

getName

get

set

remove

containsKey

getKeys

containsValue

isEmpty

size

clear

getById

getAll

clearAll

clear

hashCode

equal

paramString

toString