com.bea.p13n.property
Interface EntityPropertyCache

All Superinterfaces:

Serializable

public interface EntityPropertyCache

extends Serializable

Class used to hold properties for a given entity. An instance of this class is used as the runtime store for a ConfigurableEntity EJB during its lifecycle, as a container to pass properties from the EntityPropertyManager to an entity, and as a container to cache properties in the application-wide cache by the EntityPropertyManager.

See Also:

ConfigurableEntity, EntityPropertyManager

Method Summary

void	clear() Clear the cache
EntityPropertyCache	filterByPropertyMapKeys(Set propertyMapKeys) Return a subset of this cache containing only the named property map keys
EntityPropertyCache	filterByPropertySet(String propertySetName) Return a subset of this cache containing only the named property sets
Object	get(PropertyMapKey key) Get a value from the cache
List	getContentsAsString() Describes the contents of this cache as a List of Strings such as: {"propertySet:propertyName=propertyValue" }
Iterator	getEntries()
Map	getMap() Get the entire map that backs up the cache
boolean	isEmpty()
void	put(PropertyMapKey key, Object value) Put a value in the cache
void	putAll(Map map) Add all the key/value pairs from the given map to the cache
void	remove(PropertyMapKey key) Remove a value from the cache
int	size()

Method Detail

clear

public void clear()

Clear the cache

filterByPropertyMapKeys

public EntityPropertyCache filterByPropertyMapKeys(Set propertyMapKeys)

Return a subset of this cache containing only the named property map keys

filterByPropertySet

public EntityPropertyCache filterByPropertySet(String propertySetName)

Return a subset of this cache containing only the named property sets

get

public Object get(PropertyMapKey key)

Get a value from the cache

Parameters:

key - the key to lookup

Returns:

the property value, or null if there is none.

getContentsAsString

public List getContentsAsString()

Describes the contents of this cache as a List of Strings such as: {"propertySet:propertyName=propertyValue" }

getEntries

public Iterator getEntries()

Returns:

an Iterator over the cache entry set. Will return null for an empty cache.

getMap

public Map getMap()

Get the entire map that backs up the cache

Returns:

a Map of PropertyMapKey/value pairs

isEmpty

public boolean isEmpty()

Returns:

true if this cache is empty

put

public void put(PropertyMapKey key,
                Object value)

Put a value in the cache

Parameters:

key - the key of the new value

value - the value to cache

putAll

public void putAll(Map map)

Add all the key/value pairs from the given map to the cache

Parameters:

map - the Map containing values to add

remove

public void remove(PropertyMapKey key)

Remove a value from the cache

Parameters:

key - the key to remove

size

public int size()

Returns:

number of property entries in this cache