oracle.ifs.common

Class UnboundedCache

java.lang.Object

oracle.ifs.common.Cache

oracle.ifs.common.UnboundedCache

public final class UnboundedCache
extends Cache

An UnboundedCache is a cache that grows as needed to hold as many items as are placed in the cache.

Version:

1.0

Author:

David Pitfield

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
protected long	m_HitCount The number of cache hits.
protected Hashtable	m_Items The cache items.
protected long	m_MissCount The number of cache misses.
protected long	m_PutCount The number of cache puts.
protected long	m_RemoveCount The number of cache removes.

Fields inherited from class oracle.ifs.common.Cache

m_Configuration

Constructor Summary

Constructors

Constructor and Description
UnboundedCache(UnboundedCacheConfiguration configuration) Constructs an unbounded cache.

Method Summary

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

Methods inherited from class oracle.ifs.common.Cache

getCacheConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

m_Items

protected Hashtable m_Items

The cache items.

(Unpublished)

m_HitCount

protected long m_HitCount

The number of cache hits.

(Unpublished)

m_MissCount

protected long m_MissCount

The number of cache misses.

(Unpublished)

m_PutCount

protected long m_PutCount

The number of cache puts.

(Unpublished)

m_RemoveCount

protected long m_RemoveCount

The number of cache removes.

(Unpublished)

Constructor Detail

UnboundedCache

public UnboundedCache(UnboundedCacheConfiguration configuration)

Constructs an unbounded cache.

Parameters:

configuration - the configuration paramaters for the new cache

(Unpublished)

Method Detail

setCacheConfiguration

public final void setCacheConfiguration(CacheConfiguration configuration)
                                 throws IfsException

Alters the configuration of this cache.

No configuration parameters of an UnboundedCache are updateable. Consequently, this method is a no-op.

Specified by:

setCacheConfiguration in class Cache

Parameters:

configuration - the configuration parameters

Throws:

IfsException - (IFS-10810) if the operation fails

(Unpublished)

put

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

Puts an item in this cache.

Specified by:

put in class Cache

Parameters:

id - the item id

value - the item

Throws:

IfsException - if the operation fails

(Unpublished)

remove

public final void remove(Object id)
                  throws IfsException

Removes an item from this cache.

Specified by:

remove in class Cache

Parameters:

id - the item id

Throws:

IfsException - if the operation fails

(Unpublished)

getElements

public final Enumeration getElements()
                              throws IfsException

Gets Enumeration of items in this cache.

Overrides:

getElements in class Cache

Returns:

the enumeration of items

Throws:

IfsException - if the operation fails

(Unpublished)

find

public final Object find(Object id)
                  throws IfsException

Gets an item from this cache.

Specified by:

find in class 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)

getCachePerformance

public final CachePerformance getCachePerformance()

Gets the performance information for this cache.

Specified by:

getCachePerformance in class Cache

Returns:

a cache performance object

(Unpublished)

resetCachePerformance

public final void resetCachePerformance()

Resets the performance information for this cache.

Specified by:

resetCachePerformance in class Cache

(Unpublished)

reset

public void reset()

Resets this cache.

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

Overrides:

reset in class Cache

(Unpublished)

dispose

public void dispose()

Disposes this cache.

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

Overrides:

dispose in class Cache

(Unpublished)