|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractMap<String,Object> org.apache.commons.collections.BeanMap
public class BeanMap
An implementation of Map for JavaBeans which uses introspection to get and put properties in the bean.
If an exception occurs during attempts to get or set a property then the property is considered non existent in the Map
Nested Class Summary | |
---|---|
protected static class |
BeanMap.MyMapEntry
Map entry used by BeanMap . |
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Field Summary | |
---|---|
static HashMap |
defaultTransformers
Maps primitive Class types to transformers. |
static Object[] |
NULL_ARGUMENTS
An empty array. |
Constructor Summary | |
---|---|
BeanMap()
Constructs a new empty BeanMap . |
|
BeanMap(Object bean)
Constructs a new BeanMap that operates on the
specified bean. |
Method Summary | |
---|---|
void |
clear()
This method reinitializes the bean map to have default values for the bean's properties. |
Object |
clone()
Clone this bean map using the following process: If there is no underlying bean, return a cloned BeanMap without a bean. |
boolean |
containsKey(String name)
Returns true if the bean defines a property with the given name. |
boolean |
containsValue(Object value)
Returns true if the bean defines a property whose current value is the given object. |
protected Object |
convertType(Class newType,
Object value)
Converts the given value to the given type. |
protected Object[] |
createWriteMethodArguments(Method method,
Object value)
Creates an array of parameters to pass to the given mutator method. |
Iterator<Map.Entry<String,Object>> |
entryIterator()
Convenience method for getting an iterator over the entries. |
Set<Map.Entry<String,Object>> |
entrySet()
Gets a Set of MapEntry objects that are the mappings for this BeanMap. |
protected void |
firePropertyChange(String key,
Object oldValue,
Object newValue)
Called during a successful AbstractMap.put(Object,Object) operation. |
Object |
get(String name)
Returns the value of the bean's property with the given name. |
Object |
getBean()
Returns the bean currently being operated on. |
Method |
getReadMethod(String name)
Returns the accessor for the property with the given name. |
Class |
getType(String name)
Returns the type of the property with the given name. |
protected Transformer |
getTypeTransformer(Class aType)
Returns a transformer for the given primitive type. |
Method |
getWriteMethod(String name)
Returns the mutator for the property with the given name. |
Iterator<String> |
keyIterator()
Convenience method for getting an iterator over the keys. |
Set<String> |
keySet()
Get the keys for this BeanMap. |
protected void |
logInfo(Exception ex)
Logs the given exception to System.out . |
protected void |
logWarn(Exception ex)
Logs the given exception to System.err . |
Object |
put(String name,
Object value)
Sets the bean property with the given name to the given value. |
void |
putAllWriteable(BeanMap map)
Puts all of the writable properties from the given BeanMap into this BeanMap. |
protected void |
reinitialise()
Reinitializes this bean. |
void |
setBean(Object newBean)
Sets the bean to be operated on by this map. |
int |
size()
Returns the number of properties defined by the bean. |
String |
toString()
|
Iterator<Object> |
valueIterator()
Convenience method for getting an iterator over the values. |
Collection<Object> |
values()
Returns the values for the BeanMap. |
Methods inherited from class java.util.AbstractMap |
---|
containsKey, equals, get, hashCode, isEmpty, putAll, remove |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final Object[] NULL_ARGUMENTS
public static HashMap defaultTransformers
Constructor Detail |
---|
public BeanMap()
BeanMap
.
public BeanMap(Object bean)
BeanMap
that operates on the
specified bean. If the given bean is null
, then
this map will be empty.
bean
- the bean for this map to operate onMethod Detail |
---|
public String toString()
toString
in class AbstractMap<String,Object>
public Object clone() throws CloneNotSupportedException
clone
in class AbstractMap<String,Object>
CloneNotSupportedException
public void putAllWriteable(BeanMap map)
map
- the BeanMap whose properties to putpublic void clear()
clear()
differs from the Map contract in that
the mappings are not actually removed from the map (the mappings for a
BeanMap are fixed).
clear
in interface Map<String,Object>
clear
in class AbstractMap<String,Object>
public boolean containsKey(String name)
String
; if not, this method
returns false. This method will also return false if the bean
does not define a property with that name.
Write-only properties will not be matched as the test operates against
property read methods.
name
- the name of the property to check
String
;
false if the bean does not define a property with that name; or
true if the bean does define a property with that namepublic boolean containsValue(Object value)
containsValue
in interface Map<String,Object>
containsValue
in class AbstractMap<String,Object>
value
- the value to check
public Object get(String name)
String
and must not be
null; otherwise, this method returns null
.
If the bean defines a property with the given name, the value of
that property is returned. Otherwise, null
is
returned.
Write-only properties will not be matched as the test operates against
property read methods.
name
- the name of the property whose value to return
public Object put(String name, Object value) throws IllegalArgumentException, ClassCastException
put
in interface Map<String,Object>
put
in class AbstractMap<String,Object>
name
- the name of the property to setvalue
- the value to set that property to
IllegalArgumentException
- if the given name is null;
if the given name is not a String
; if the bean doesn't
define a property with that name; or if the bean property with
that name is read-only
ClassCastException
public int size()
size
in interface Map<String,Object>
size
in class AbstractMap<String,Object>
public Set<String> keySet()
keySet
in interface Map<String,Object>
keySet
in class AbstractMap<String,Object>
public Set<Map.Entry<String,Object>> entrySet()
entrySet
in interface Map<String,Object>
entrySet
in class AbstractMap<String,Object>
public Collection<Object> values()
values
in interface Map<String,Object>
values
in class AbstractMap<String,Object>
public Class getType(String name)
name
- the name of the property
null
if no such
property existspublic Iterator<String> keyIterator()
public Iterator<Object> valueIterator()
public Iterator<Map.Entry<String,Object>> entryIterator()
public Object getBean()
public void setBean(Object newBean)
newBean
- the new bean to operate onpublic Method getReadMethod(String name)
name
- the name of the property
public Method getWriteMethod(String name)
name
- the name of the property
protected void reinitialise()
setBean(Object)
.
Does introspection to find properties.
protected void firePropertyChange(String key, Object oldValue, Object newValue)
AbstractMap.put(Object,Object)
operation.
Default implementation does nothing. Override to be notified of
property changes in the bean caused by this map.
key
- the name of the property that changedoldValue
- the old value for that propertynewValue
- the new value for that propertyprotected Object[] createWriteMethodArguments(Method method, Object value) throws IllegalAccessException, ClassCastException
convertType(Class,Object)
.
method
- the mutator methodvalue
- the value to pass to the mutator method
IllegalAccessException
- if convertType(Class,Object)
raises it
IllegalArgumentException
- if any other exception is raised
by convertType(Class,Object)
ClassCastException
protected Object convertType(Class newType, Object value) throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException
If no such constructor exists, and the given type is a primitive type, then the given value is converted to a string using its
toString()
method, and that string is
parsed into the correct primitive type using, for instance,
Integer.valueOf(String)
to convert the string into an
int
.If no special constructor exists and the given type is not a primitive type, this method returns the original value.
newType
- the type to convert the value tovalue
- the value to convert
NumberFormatException
- if newType is a primitive type, and
the string representation of the given value cannot be converted
to that type
InstantiationException
- if the constructor found with
reflection raises it
InvocationTargetException
- if the constructor found with
reflection raises it
IllegalAccessException
- never
IllegalArgumentException
- neverprotected Transformer getTypeTransformer(Class aType)
aType
- the primitive type whose transformer to return
protected void logInfo(Exception ex)
System.out
. Used to display
warnings while accessing/mutating the bean.
ex
- the exception to logprotected void logWarn(Exception ex)
System.err
. Used to display
errors while accessing/mutating the bean.
ex
- the exception to log
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |