|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.util.AbstractMap
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 class java.util.AbstractMap |
---|
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
java.util.Map.Entry<K,V> |
Field Summary | |
---|---|
static java.util.HashMap |
defaultTransformers
Maps primitive Class types to transformers. |
static java.lang.Object[] |
NULL_ARGUMENTS
An empty array. |
Constructor Summary | |
---|---|
BeanMap()
Constructs a new empty BeanMap . |
|
BeanMap(java.lang.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. |
java.lang.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(java.lang.Object name)
Returns true if the bean defines a property with the given name. |
boolean |
containsValue(java.lang.Object value)
Returns true if the bean defines a property whose current value is the given object. |
protected java.lang.Object |
convertType(java.lang.Class newType,
java.lang.Object value)
Converts the given value to the given type. |
protected java.lang.Object[] |
createWriteMethodArguments(java.lang.reflect.Method method,
java.lang.Object value)
Creates an array of parameters to pass to the given mutator method. |
java.util.Iterator |
entryIterator()
Convenience method for getting an iterator over the entries. |
java.util.Set |
entrySet()
Get the mappings for this BeanMap |
protected void |
firePropertyChange(java.lang.Object key,
java.lang.Object oldValue,
java.lang.Object newValue)
Called during a successful put(Object,Object) operation. |
java.lang.Object |
get(java.lang.Object name)
Returns the value of the bean's property with the given name. |
java.lang.Object |
getBean()
Returns the bean currently being operated on. |
protected java.lang.reflect.Method |
getReadMethod(java.lang.Object name)
Returns the accessor for the property with the given name. |
java.lang.Class |
getType(java.lang.String name)
Returns the type of the property with the given name. |
protected Transformer |
getTypeTransformer(java.lang.Class aType)
Returns a transformer for the given primitive type. |
protected java.lang.reflect.Method |
getWriteMethod(java.lang.Object name)
Returns the mutator for the property with the given name. |
java.util.Iterator |
keyIterator()
Convenience method for getting an iterator over the keys. |
java.util.Set |
keySet()
Get the keys for this BeanMap. |
protected void |
logInfo(java.lang.Exception e)
Logs the given exception to System.out . |
protected void |
logWarn(java.lang.Exception e)
Logs the given exception to System.err . |
java.lang.Object |
put(java.lang.Object name,
java.lang.Object value)
Sets the bean property with the given name to the given value. |
void |
putAllWriteable(BeanMap map)
Puts all of the writeable properties from the given BeanMap into this BeanMap. |
protected void |
reinitialise()
Reinitializes this bean. |
void |
setBean(java.lang.Object newBean)
Sets the bean to be operated on by this map. |
int |
size()
Returns the number of properties defined by the bean. |
java.util.Iterator |
valueIterator()
Convenience method for getting an iterator over the values. |
java.util.Collection |
values()
Returns the values for the BeanMap. |
Methods inherited from class java.util.AbstractMap |
---|
equals, hashCode, isEmpty, putAll, remove, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.util.HashMap defaultTransformers
public static final java.lang.Object[] NULL_ARGUMENTS
Constructor Detail |
---|
public BeanMap()
BeanMap
.
public BeanMap(java.lang.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 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 java.util.Map
clear
in class java.util.AbstractMap
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.util.AbstractMap
java.lang.CloneNotSupportedException
public boolean containsKey(java.lang.Object 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.
containsKey
in interface java.util.Map
containsKey
in class java.util.AbstractMap
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(java.lang.Object value)
containsValue
in interface java.util.Map
containsValue
in class java.util.AbstractMap
value
- the value to check
protected java.lang.Object convertType(java.lang.Class newType, java.lang.Object value) throws java.lang.InstantiationException, java.lang.IllegalAccessException, java.lang.IllegalArgumentException, java.lang.reflect.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 primitve 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 conert
java.lang.NumberFormatException
- if newType is a primitive type, and
the string representation of the given value cannot be converted
to that type
java.lang.InstantiationException
- if the constructor found with
reflection raises it
InvocationTargetExcetpion
- if the constructor found with
reflection raises it
java.lang.IllegalAccessException
- never
java.lang.IllegalArgumentException
- never
java.lang.reflect.InvocationTargetException
protected java.lang.Object[] createWriteMethodArguments(java.lang.reflect.Method method, java.lang.Object value) throws java.lang.IllegalAccessException, java.lang.ClassCastException
convertType(Class,Object)
.
method
- the mutator methodvalue
- the value to pass to the mutator method
java.lang.IllegalAccessException
- if convertType(Class,Object)
raises it
java.lang.IllegalArgumentException
- if any other exception is raised
by convertType(Class,Object)
java.lang.ClassCastException
public java.util.Iterator entryIterator()
public java.util.Set entrySet()
entrySet
in interface java.util.Map
entrySet
in class java.util.AbstractMap
protected void firePropertyChange(java.lang.Object key, java.lang.Object oldValue, java.lang.Object newValue)
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 propertypublic java.lang.Object get(java.lang.Object 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.
get
in interface java.util.Map
get
in class java.util.AbstractMap
name
- the name of the property whose value to return
public java.lang.Object getBean()
protected java.lang.reflect.Method getReadMethod(java.lang.Object name)
name
- the name of the property
String
; null if no such property exists; or the accessor
method for that propertypublic java.lang.Class getType(java.lang.String name)
name
- the name of the property
null
if no such
property existsprotected Transformer getTypeTransformer(java.lang.Class aType)
aType
- the primitive type whose transformer to return
protected java.lang.reflect.Method getWriteMethod(java.lang.Object name)
name
- the name of the
String
; null if no such property exists; null if the
property is read-only; or the mutator method for that propertypublic java.util.Iterator keyIterator()
public java.util.Set keySet()
keySet
in interface java.util.Map
keySet
in class java.util.AbstractMap
protected void logInfo(java.lang.Exception e)
System.out
. Used to display
warnings while accessing/mutating the bean.
e
- the exception to logprotected void logWarn(java.lang.Exception e)
System.err
. Used to display
errors while accessing/mutating the bean.
e
- the exception to logpublic java.lang.Object put(java.lang.Object name, java.lang.Object value) throws java.lang.IllegalArgumentException, java.lang.ClassCastException
put
in interface java.util.Map
put
in class java.util.AbstractMap
name
- the name of the property to setvalue
- the value to set that property to
java.lang.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
java.lang.ClassCastException
public void putAllWriteable(BeanMap map)
map
- the BeanMap whose properties to putprotected void reinitialise()
setBean(Object)
.
Does introspection to find properties.
public void setBean(java.lang.Object newBean)
newBean
- the new bean to operate onpublic int size()
size
in interface java.util.Map
size
in class java.util.AbstractMap
public java.util.Iterator valueIterator()
public java.util.Collection values()
values
in interface java.util.Map
values
in class java.util.AbstractMap
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |