# com.bea.p13n.property
EntityPropertyCache Interface

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.

Related Topics

``ConfigurableEntity``
``EntityPropertyManager``

All Superinterfaces
  `Serializable`

## Method Summary

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

## Method Detail

### clear() Method

    public void clear()

Clear the cache

### filterByPropertyMapKeys(Set) Method

    public EntityPropertyCache filterByPropertyMapKeys(Set propertyMapKeys)

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

### filterByPropertySet(String) Method

    public EntityPropertyCache filterByPropertySet(String propertySetName)

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

### get(PropertyMapKey) Method

    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() Method

    public List getContentsAsString()

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

### getEntries() Method

    public Iterator getEntries()

#### Returns

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

### getMap() Method

    public Map getMap()

Get the entire map that backs up the cache

#### Returns

a Map of PropertyMapKey/value pairs

### isEmpty() Method

    public boolean isEmpty()

#### Returns

true if this cache is empty

### put(PropertyMapKey, Object) Method

    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(Map) Method

    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(PropertyMapKey) Method

    public void remove(PropertyMapKey key)

Remove a value from the cache

#### Parameters

key
  the key to remove

### size() Method

    public int size()

#### Returns

number of property entries in this cache