com.jayway.android.robotium.remotecontrol.client.processor

Interface CacheReferenceInterface

All Known Implementing Classes:

DriverProcessor, EngineProcessor, SoloProcessor

public interface CacheReferenceInterface

Defines the required API for a Processor able to share cached object references.

Author:

CarlNagle

Method Summary

Modifier and Type	Method and Description
void	addCacheReferenceInterface(CacheReferenceInterface cache) Add an instance of CacheReferenceInterface to the set of caches to be chained when seeking an object by key.
void	clearCache(boolean useChain) Clear the cache of all object and key references.
java.lang.Object	getCachedObject(java.lang.String key, boolean useChain) Retrieve a cached object from the class instance.
void	removeCacheReferenceInterface(CacheReferenceInterface cache) Remove an instance of CacheReferenceInterface from the set of caches to be chained when seeking an object by key.

Method Detail

getCachedObject

java.lang.Object getCachedObject(java.lang.String key,
                                 boolean useChain)

Retrieve a cached object from the class instance.

Parameters:

key - -- String key for identifying the object stored in cache.

useChain - -- true if the instance should search in all chained caches, false if only the individual local cache should be searched.

Returns:

-- the object stored in cache identified by the key, or null if not found.

addCacheReferenceInterface

void addCacheReferenceInterface(CacheReferenceInterface cache)

Add an instance of CacheReferenceInterface to the set of caches to be chained when seeking an object by key.

Parameters:

cache -

removeCacheReferenceInterface

void removeCacheReferenceInterface(CacheReferenceInterface cache)

Remove an instance of CacheReferenceInterface from the set of caches to be chained when seeking an object by key.

Parameters:

cache -

clearCache

void clearCache(boolean useChain)

Clear the cache of all object and key references.

Parameters:

useChain - -- true if the instance should clear all chained caches, false if only the individual local cache should be cleared.