ExpiringCache (Oracle Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC))

java.lang.Object
- oracle.stellent.ridc.common.cache.ExpiringCache<K,V>

@Concealed
public class ExpiringCache<K,V>
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BUCKET_COUNT` Default number of concurrent writes to support : 16 (must be a power of 2)
`static int`	`DEFAULT_BUCKET_INITIAL_SIZE` Default initial size of a bucket : 8 (must be power of 2)
`static int`	`DEFAULT_BUCKET_READ_COUNT_EXPIRATION_CHECK_INTERVAL` Default bucket read count interval at which a bucket's entries are additionally checked for expiration (must be a power of 2 minus 1) 31 indicates that expiration check will occur when mReadCount for bucket is at 32,64,96,128,160,192,....
`static long`	`DEFAULT_ENTRY_VALIDITY_MS` Default validity time/duration of a bucket entry in milliseconds : 10 minutes
`static int`	`UNRESTRICTED_BUCKET_MAX_SIZE` max size of a bucket : 0 - unlimited
`static int`	`UNRESTRICTED_ENTRY_VALIDITY` cache entries will never expire due to age : 0 - unlimited Note - cache entries may still be removed in the event a max bucket size is specified

Constructor Summary

Constructors
Constructor and Description
`ExpiringCache()`
`ExpiringCache(int initialCacheSize)`
`ExpiringCache(int bucketCount, int bucketInitialSize, int bucketMaxSize, long entryValidityMS, int readCountCheckInterval)`
`ExpiringCache(int initialCacheSize, int maxCacheSize, long entryValidityMS)`
`ExpiringCache(int initialCacheSize, long entryValidityMS)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear all entries from cache.
`V`	`get(K key)` Return value from cache linked to key; otherwise null.
`V`	`put(K key, V value)` Store/replace object in cache, returning existing value if present Supplying a value of null is equivalent to a remove operation
`V`	`remove(K key)` Remove entry from cache linked to key, returning entry value if non-expired; otherwise null.
`long`	`removeExpiredEntries()` Remove expired entries returning an approximation of the number of revised entries now cached
`long`	`size()` Return an approximation of how many entries are cached; Count may include entries potentially expired!

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

- Field Detail
  - DEFAULT_BUCKET_COUNT
```
public static final int DEFAULT_BUCKET_COUNT
```
    Default number of concurrent writes to support : 16 (must be a power of 2)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUCKET_INITIAL_SIZE
```
public static final int DEFAULT_BUCKET_INITIAL_SIZE
```
    Default initial size of a bucket : 8 (must be power of 2)
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ENTRY_VALIDITY_MS
```
public static final long DEFAULT_ENTRY_VALIDITY_MS
```
    Default validity time/duration of a bucket entry in milliseconds : 10 minutes
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUCKET_READ_COUNT_EXPIRATION_CHECK_INTERVAL
```
public static final int DEFAULT_BUCKET_READ_COUNT_EXPIRATION_CHECK_INTERVAL
```
    Default bucket read count interval at which a bucket's entries are additionally checked for expiration (must be a power of 2 minus 1) 31 indicates that expiration check will occur when mReadCount for bucket is at 32,64,96,128,160,192,....
    
    See Also:
    
    Constant Field Values
  - UNRESTRICTED_BUCKET_MAX_SIZE
```
public static final int UNRESTRICTED_BUCKET_MAX_SIZE
```
    max size of a bucket : 0 - unlimited
    
    See Also:
    
    Constant Field Values
  - UNRESTRICTED_ENTRY_VALIDITY
```
public static final int UNRESTRICTED_ENTRY_VALIDITY
```
    cache entries will never expire due to age : 0 - unlimited Note - cache entries may still be removed in the event a max bucket size is specified
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExpiringCache
```
public ExpiringCache()
```
  - ExpiringCache
```
public ExpiringCache(int initialCacheSize)
```
  - ExpiringCache
```
public ExpiringCache(int initialCacheSize,
                     long entryValidityMS)
```
  - ExpiringCache
```
public ExpiringCache(int initialCacheSize,
                     int maxCacheSize,
                     long entryValidityMS)
```
  - ExpiringCache
```
public ExpiringCache(int bucketCount,
                     int bucketInitialSize,
                     int bucketMaxSize,
                     long entryValidityMS,
                     int readCountCheckInterval)
```
- Method Detail
  - clear
```
public void clear()
```
    Clear all entries from cache.
  - get
```
public V get(K key)
```
    Return value from cache linked to key; otherwise null.
  - put
```
public V put(K key,
             V value)
```
    Store/replace object in cache, returning existing value if present Supplying a value of null is equivalent to a remove operation
  - remove
```
public V remove(K key)
```
    Remove entry from cache linked to key, returning entry value if non-expired; otherwise null.
  - removeExpiredEntries
```
public long removeExpiredEntries()
```
    Remove expired entries returning an approximation of the number of revised entries now cached
  - size
```
public long size()
```
    Return an approximation of how many entries are cached; Count may include entries potentially expired!

Class ExpiringCache<K,V>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BUCKET_COUNT

DEFAULT_BUCKET_INITIAL_SIZE

DEFAULT_ENTRY_VALIDITY_MS

DEFAULT_BUCKET_READ_COUNT_EXPIRATION_CHECK_INTERVAL

UNRESTRICTED_BUCKET_MAX_SIZE

UNRESTRICTED_ENTRY_VALIDITY

Constructor Detail

ExpiringCache

ExpiringCache

ExpiringCache

ExpiringCache

ExpiringCache

Method Detail

clear

get

put

remove

removeExpiredEntries

size