oracle.ifs.common

Class Cache

java.lang.Object

oracle.ifs.common.Cache

Direct Known Subclasses:

BoundedCache, UnboundedCache, UncommittedLibraryObjectDataCache, UncommittedResolvedAclCache

public abstract class Cache
extends Object

A Cache is a cache of arbitrary objects identified by Longs.

Version:

1.0

Author:

David Pitfield

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected CacheConfiguration	m_Configuration The configuration parameters of this cache.

Constructor Summary

Constructors

Constructor and Description
Cache(CacheConfiguration configuration) Constructs a cache.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes this cache.
abstract Object	find(Object id) Gets an item from this cache.
CacheConfiguration	getCacheConfiguration() Gets the configuration parameters of this cache.
abstract CachePerformance	getCachePerformance() Gets the performance information for this cache.
Enumeration	getElements() Gets an Enumeration of the items in this cache.
abstract void	put(Object id, Object value) Puts an item in this cache.
abstract void	remove(Object id) Removes an item from this cache.
void	reset() Resets this cache.
abstract void	resetCachePerformance() Resets the performance information for this cache.
abstract void	setCacheConfiguration(CacheConfiguration configuration) Alters the configuration of this cache.

Methods inherited from class java.lang.Object

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

Field Detail

m_Configuration

protected CacheConfiguration m_Configuration

The configuration parameters of this cache.

(Unpublished)

Constructor Detail

Cache

public Cache(CacheConfiguration configuration)

Constructs a cache.

Parameters:

configuration - the configuration parameters for the new cache

(Unpublished)

Method Detail

getCacheConfiguration

public final CacheConfiguration getCacheConfiguration()

Gets the configuration parameters of this cache.

This method returns a copy of the configuration parameters for this cache. To alter the configuration of this cache, use the CacheConfiguration mutators to adjust the parameters' values and then call setCacheConfiguration to apply the altered CacheConfiguration.

Returns:

the cache configuration

(Unpublished)

setCacheConfiguration

public abstract void setCacheConfiguration(CacheConfiguration configuration)
                                    throws IfsException

Alters the configuration of this cache.

Certain cache configuration parameters may be immutable; the CacheConfiguration value of any such parameter will be ignored. Refer to the Javadoc of each concrete Cache subclass for a list of such parameters.

Parameters:

configuration - the configuration parameters

Throws:

IfsException - (IFS-10810) if the operation fails

(Unpublished)

put

public abstract void put(Object id,
                         Object value)
                  throws IfsException

Puts an item in this cache.

Parameters:

id - the item id

value - the item

Throws:

IfsException - if the operation fails

(Unpublished)

remove

public abstract void remove(Object id)
                     throws IfsException

Removes an item from this cache.

Parameters:

id - the item id

Throws:

IfsException - if the operation fails

(Unpublished)

find

public abstract Object find(Object id)
                     throws IfsException

Gets an item from this cache.

Parameters:

id - the item id

Returns:

the item, or null if the item is not in this cache

Throws:

IfsException - if the operation fails

(Unpublished)

getElements

public Enumeration getElements()
                        throws IfsException

Gets an Enumeration of the items in this cache. This will throw an IfsException (IFS-19008) unless the subclass overrides with an implementation.

Returns:

the enumeration of items

Throws:

IfsException - (IFS-19008) if an Enumeration is not available

(Unpublished)

getCachePerformance

public abstract CachePerformance getCachePerformance()

Gets the performance information for this cache.

Returns:

a cache performance object

(Unpublished)

resetCachePerformance

public abstract void resetCachePerformance()

Resets the performance information for this cache.

(Unpublished)

reset

public void reset()

Resets this cache.

This causes the cache to be emptied and its performance information to be reset.

(Unpublished)

dispose

public void dispose()

Disposes this cache.

After the cache is disposed, it is invalid to use this cache.

(Unpublished)