oracle.ide.adapters

Class AbstractCachingAdapterFactory<A,T>

java.lang.Object

oracle.ide.adapters.AbstractCachingAdapterFactory<A,T>

Type Parameters:

A -

T -

All Implemented Interfaces:

AdapterFactory<A,T>

public abstract class AbstractCachingAdapterFactory<A,T>
extends java.lang.Object
implements AdapterFactory<A,T>

The AbstractCachingAdapterFactory class may be used to implement an AdapterFactory that provides caching of target instances keyed by their respective adaptable objects.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CACHE_SIZE The default maximum cache size.

Constructor Summary

Constructors

Constructor and Description
AbstractCachingAdapterFactory()

Method Summary

Methods

Modifier and Type	Method and Description
T	adapt(A obj) Adapt the given object to the target type.
abstract T	adaptImpl(A obj) Perform the adaptation of the given object to the declared target type.
protected void	addToCache(A adaptable, T target) Add the given target instance for the given adaptable object to the cache.
protected void	clearCache() Removes all entries from the cache.
protected T	findInCache(A adaptable) Find the target instance for the given adaptable object in the cache.
protected int	getMaxCacheSize() Get the maximum number of entries to be cached.
protected void	removeFromCache(A adaptable) Remove the adaptable object as well as its adapted type from the cache.
protected boolean	shouldRemoveFromCache(java.util.Map.Entry<A,T> entry) Determine if the given entry should be removed from the cache.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_CACHE_SIZE

public static final int DEFAULT_MAX_CACHE_SIZE

The default maximum cache size. Value is 100.

See Also:

Constant Field Values

Constructor Detail

AbstractCachingAdapterFactory

public AbstractCachingAdapterFactory()

Method Detail

getMaxCacheSize

protected int getMaxCacheSize()

Get the maximum number of entries to be cached. Subclasses may override this method to supply their own value. Default value is DEFAULT_MAX_CACHE_SIZE.

Returns:

the maximum number of entries to be cached

shouldRemoveFromCache

protected boolean shouldRemoveFromCache(java.util.Map.Entry<A,T> entry)

Determine if the given entry should be removed from the cache. This implementation checks to see if the size of the cache has reached the maximum. Subclasses may override this method to determine if the given entry should be removed.

Parameters:

entry - the candidate to be removed from the cache

Returns:

true if the given entry should be removed from the cache, false otherwise

findInCache

protected final T findInCache(A adaptable)

Find the target instance for the given adaptable object in the cache.

Parameters:

adaptable - the object for which to find the cached target instance

Returns:

the target instance for the given adaptable object if found in the cache, null otherwise

addToCache

protected final void addToCache(A adaptable,
              T target)

Add the given target instance for the given adaptable object to the cache.

Parameters:

adaptable - the adaptable object

target - the target instance

removeFromCache

protected final void removeFromCache(A adaptable)

Remove the adaptable object as well as its adapted type from the cache.

Parameters:

adaptable - the adaptable object

clearCache

protected final void clearCache()

Removes all entries from the cache.

adapt

public final T adapt(A obj)

Adapt the given object to the target type. This implementation first checks to see if a target instance is already in the cache, returning that if it is found. Otherwise the adaptImpl(Object) method is invoked, its return value stored in the cache and returned to the caller.

Specified by:

adapt in interface AdapterFactory<A,T>

Parameters:

obj - the object to be adapted

Returns:

the adapted object or null if the given object could not be adapted

adaptImpl

public abstract T adaptImpl(A obj)

Perform the adaptation of the given object to the declared target type. This method is called only if an existing target instance is not found in the cache. The returned instance will be stored in the cache prior to being returned to the caller.

Note: this method is public for internal adapter framework reasons. This method is not intended to be called by clients.

Parameters:

obj - the object to be adapted

Returns:

the adapted object or null if the given object could not be adapted