IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.base
Interface Cache

All Known Implementing Classes:
Externalizer

public interface Cache


Method Summary
 void clearCacheTable()
          This method empties the cache
 Hashtable getCacheTable()
          This method returns the objects cache.
 Cacheable getFromCacheTable(java.lang.String key)
          Removes an element with id=key from the cache and returns it.
 boolean isCachingEnabled()
          Returns true if element caching is possible.
 void putIntoCacheTable(Cacheable object)
          Places the element 'cacheable' into the cache.
 void setCachingEnabled(boolean newValue)
          This method enables or disables the element caching.
 

Method Detail

clearCacheTable

public void clearCacheTable()
This method empties the cache


getCacheTable

public Hashtable getCacheTable()
This method returns the objects cache.

Returns:
com.ibm.btt.base.Hashtable

getFromCacheTable

public Cacheable getFromCacheTable(java.lang.String key)
                            throws java.io.IOException
Removes an element with id=key from the cache and returns it. If there are no elements in the cache with id=key, null is returned.

Parameters:
key - java.lang.String
Returns:
com.ibm.btt.base.Cacheable
Throws:
java.io.IOException

isCachingEnabled

public boolean isCachingEnabled()
Returns true if element caching is possible.

Returns:
boolean

putIntoCacheTable

public void putIntoCacheTable(Cacheable object)
                       throws java.io.IOException
Places the element 'cacheable' into the cache. The element is keyed with its name in the cache.

Throws:
java.io.IOException

setCachingEnabled

public void setCachingEnabled(boolean newValue)
This method enables or disables the element caching. if newValue = true, then object caching is enabled.

Parameters:
newValue - boolean

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005