net.sf.cglib.beans
Class BeanMap
java.lang.Object
net.sf.cglib.beans.BeanMap
- Map
public abstract class BeanMap
extends java.lang.Object
implements Map
A Map
-based view of a JavaBean. The default set of keys is the
union of all property names (getters or setters). An attempt to set
a read-only property will be ignored, and write-only properties will
be returned as null
. Removal of objects is not a
supported (the key set is fixed).
static int | REQUIRE_GETTER - Limit the properties reflected in the key set of the map
to readable properties.
|
static int | REQUIRE_SETTER - Limit the properties reflected in the key set of the map
to writable properties.
|
void | clear()
|
boolean | containsKey(Object key)
|
boolean | containsValue(Object value)
|
static BeanMap | create(Object bean) - Helper method to create a new
BeanMap .
|
Set | entrySet()
|
boolean | equals(Object o)
|
Object | get(Object key)
|
abstract Object | get(Object bean, Object key) - Get the property of a bean.
|
Object | getBean() - Return the bean currently in use by this map.
|
abstract Class | getPropertyType(String name) - Get the type of a property.
|
int | hashCode()
|
boolean | isEmpty()
|
abstract BeanMap | newInstance(Object bean) - Create a new
BeanMap instance using the specified bean.
|
Object | put(Object key, Object value)
|
abstract Object | put(Object bean, Object key, Object value) - Set the property of a bean.
|
void | putAll(Map t)
|
Object | remove(Object key)
|
void | setBean(Object bean) - Change the underlying bean this map should use.
|
int | size()
|
String | toString()
|
Collection | values()
|
REQUIRE_GETTER
public static final int REQUIRE_GETTER
Limit the properties reflected in the key set of the map
to readable properties.
REQUIRE_SETTER
public static final int REQUIRE_SETTER
Limit the properties reflected in the key set of the map
to writable properties.
containsKey
public boolean containsKey(Object key)
containsValue
public boolean containsValue(Object value)
create
public static BeanMap create(Object bean)
Helper method to create a new BeanMap
. For finer
control over the generated instance, use a new instance of
BeanMap.Generator
instead of this static method.
bean
- the JavaBean underlying the map
entrySet
public Set entrySet()
equals
public boolean equals(Object o)
get
public Object get(Object key)
get
public abstract Object get(Object bean,
Object key)
Get the property of a bean. This allows a BeanMap
to be used statically for multiple beans--the bean instance tied to the
map is ignored and the bean passed to this method is used instead.
bean
- the bean to query; must be compatible with the type of
this BeanMap
key
- must be a String
- the current value, or null if there is no matching property
getBean
public Object getBean()
Return the bean currently in use by this map.
getPropertyType
public abstract Class getPropertyType(String name)
Get the type of a property.
name
- the name of the JavaBean property
- the type of the property, or null if the property does not exist
hashCode
public int hashCode()
isEmpty
public boolean isEmpty()
newInstance
public abstract BeanMap newInstance(Object bean)
Create a new
BeanMap
instance using the specified bean.
This is faster than using the
create(Object)
static method.
bean
- the JavaBean underlying the map
put
public Object put(Object key,
Object value)
put
public abstract Object put(Object bean,
Object key,
Object value)
Set the property of a bean. This allows a BeanMap
to be used statically for multiple beans--the bean instance tied to the
map is ignored and the bean passed to this method is used instead.
- the old value, if there was one, or null
putAll
public void putAll(Map t)
remove
public Object remove(Object key)
setBean
public void setBean(Object bean)
Change the underlying bean this map should use.
toString
public String toString()
values
public Collection values()
Copyright (c) 2001 - Apache Software Foundation