Cache (OpenText Process Suite Platform 10.8 Java SDK API)

Constructor Summary

Constructors
Constructor and Description
`Cache(long maxSize)`
`Cache(long maxSize, java.util.Hashtable<?,?> initValues)`
`Cache(long maxSize, java.util.Map<K,V> initValues, java.util.Comparator<K> comparator)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`cleanCacheValueInternal(CacheKey key, CacheValue value)` Release all claimed resources.
`protected void`	`finalize()`
`CacheValue`	`get(CacheKey key)` Get the object (and load when not in the cache).
`static <K extends CacheKey & java.lang.Comparable<K>> java.util.Comparator<K>`	`getKeyComparator(java.lang.Class<K> theClass)`
`protected java.util.Enumeration`	`getKeys()` Returns an thread-safe enumeration the key's in the cache.
`protected <K extends CacheKey> java.util.Collection<K>`	`getKeys(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)` Returns a thread-safe read only view to the specified key range in the cache.
`protected long`	`getSize()`
`void`	`invalidate(CacheKey key)` Invalidate the key (dirty event, pruning), when all locks are released, the value will be cleaned.
`void`	`invalidate(CacheValue value)` Invalidate the value (pruning), when all locks are released, the value will be cleaned.
`protected abstract CacheValue`	`loadCacheValueInternal(CacheKey key)` Load the object from an external source.
`protected void`	`notifyCacheHit()` Extension point for sub-classes that want to maintain statistics about cache hits and misses.
`protected void`	`notifyCacheHit(CacheKey key)` Extension point for sub-classes that want to maintain statistics about cache hits.
`protected void`	`notifyCacheMiss()` Extension point for sub-classes that want to maintain statistics about cache hits and misses.
`protected void`	`notifyCacheMiss(CacheKey key)` Extension point for sub-classes that want to maintain statistics about cache misses.
`protected void`	`prune()` Prune the cache: invalidate Least-Recently-Used objects until size <= maxSize.
`void`	`releaseValue(CacheValue value)` Release the value
`void`	`reset()` Reset the cache by removing all cached data, and releasing all claimed resources.
`void`	`setExpiration(long expiration)` Data will be invalidated within a period of time (To be used when cache updating is too expensive or not possible, e.g.
`void`	`setMaxIdleTime(long maxIdleTime)` Free resources when an entry is not used in a period of time.
`void`	`setMaxSize(long maxSize)` Sets the maximum cacheSize.

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

- Constructor Detail
  - Cache
```
public Cache(long maxSize)
```
  - Cache
```
public Cache(long maxSize,
             java.util.Hashtable<?,?> initValues)
```
  - Cache
```
public Cache(long maxSize,
             java.util.Map<K,V> initValues,
             java.util.Comparator<K> comparator)
```
- Method Detail
  - getKeyComparator
```
public static <K extends CacheKey & java.lang.Comparable<K>> java.util.Comparator<K> getKeyComparator(java.lang.Class<K> theClass)
```
  - reset
```
public void reset()
```
    Reset the cache by removing all cached data, and releasing all claimed resources.
  - getKeys
```
protected java.util.Enumeration getKeys()
```
    Returns an thread-safe enumeration the key's in the cache.
    
    Returns:
  - getKeys
```
protected <K extends CacheKey> java.util.Collection<K> getKeys(K fromKey,
                                                               boolean fromInclusive,
                                                               K toKey,
                                                               boolean toInclusive)
```
    Returns a thread-safe read only view to the specified key range in the cache.
    
    Returns:
  - setMaxSize
```
public void setMaxSize(long maxSize)
```
    Sets the maximum cacheSize.
    
    Parameters:
    
    maxSize -
  - get
```
public CacheValue get(CacheKey key)
               throws CacheLoadingException
```
    Get the object (and load when not in the cache).
    
    Parameters:
    
    readLock -
    
    key -
    
    Returns:
    
    the cacheValue. This object should be released with releaseValue, otherwise the cache will never remove the object.
    
    Throws:
    
    CacheLoadingException
  - notifyCacheMiss
```
protected void notifyCacheMiss()
```
    Extension point for sub-classes that want to maintain statistics about cache hits and misses.
  - notifyCacheHit
```
protected void notifyCacheHit()
```
    Extension point for sub-classes that want to maintain statistics about cache hits and misses.
  - notifyCacheMiss
```
protected void notifyCacheMiss(CacheKey key)
```
    Extension point for sub-classes that want to maintain statistics about cache misses. It differs from notifyCacheMiss() w.r.t parameter. Now, sub-classes know for which key it was a cache miss.
    
    Parameters:
    
    cache - key for which a miss is to be notified
    
    Since:
    
    BOP 4.2 (D1.002)
  - notifyCacheHit
```
protected void notifyCacheHit(CacheKey key)
```
    Extension point for sub-classes that want to maintain statistics about cache hits. It differs from notifyCacheHit() w.r.t parameter. Now, sub-classes know for which key it was a cache hit.
    
    Parameters:
    
    cache - key for which a hit is to be notified
    
    Since:
    
    BOP 4.2 (D1.002)
  - releaseValue
```
public void releaseValue(CacheValue value)
```
    Release the value
    
    Parameters:
    
    value -
  - cleanCacheValueInternal
```
protected abstract void cleanCacheValueInternal(CacheKey key,
                                                CacheValue value)
```
    Release all claimed resources.
    
    Parameters:
    
    key -
    
    value -
  - loadCacheValueInternal
```
protected abstract CacheValue loadCacheValueInternal(CacheKey key)
                                              throws CacheLoadingException
```
    Load the object from an external source. This method may throw runtime exceptions, which are rethrown in the get(...) method. This method will be called only once for each key.
    
    Parameters:
    
    key -
    
    Returns:
    
    the created cache value object.
    
    Throws:
    
    CacheLoadingException
  - getSize
```
protected long getSize()
```
    Returns:
    
    the current size of the cache.
  - invalidate
```
public void invalidate(CacheValue value)
```
    Invalidate the value (pruning), when all locks are released, the value will be cleaned.
    
    Parameters:
    
    key -
  - invalidate
```
public void invalidate(CacheKey key)
                throws CorruptCacheError
```
    Invalidate the key (dirty event, pruning), when all locks are released, the value will be cleaned.
    
    Parameters:
    
    key -
    
    Throws:
    
    CorruptCacheError
  - prune
```
protected void prune()
```
    Prune the cache: invalidate Least-Recently-Used objects until size <= maxSize.
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
    
    See Also:
    
    Object.finalize()
  - setMaxIdleTime
```
public void setMaxIdleTime(long maxIdleTime)
```
    Free resources when an entry is not used in a period of time. (Also pruning the cache when it is not full).
    
    Parameters:
    
    maxIdleTime - maximum idle time in millis.
  - setExpiration
```
public void setExpiration(long expiration)
```
    Data will be invalidated within a period of time (To be used when cache updating is too expensive or not possible, e.g. UserAccess cache).
    
    Parameters:
    
    expiration - expiry period in millis.

Class Cache

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cache

Cache

Cache

Method Detail

getKeyComparator

reset

getKeys

getKeys

setMaxSize

get

notifyCacheMiss

notifyCacheHit

notifyCacheMiss

notifyCacheHit

releaseValue

cleanCacheValueInternal

loadCacheValueInternal

getSize

invalidate

invalidate

prune

finalize

setMaxIdleTime

setExpiration