Class BeanMap
- java.lang.Object
-
- java.util.AbstractMap
-
- org.apache.commons.collections.BeanMap
-
public class BeanMap extends AbstractMap implements Cloneable
Deprecated.Identical class now available in commons-beanutils (full jar version). This version is due to be removed in collections v4.0.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
- Since:
- Commons Collections 1.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- Author:
- James Strachan, Stephen Colebourne, Dimiter Dimitrov
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
BeanMap.MyMapEntry
Deprecated.Map entry used byBeanMap
.-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static HashMap
defaultTransformers
Deprecated.Maps primitive Class types to transformers.static Object[]
NULL_ARGUMENTS
Deprecated.An empty array.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
clear()
Deprecated.This method reinitializes the bean map to have default values for the bean's properties.Object
clone()
Deprecated.Clone this bean map using the following process: If there is no underlying bean, return a cloned BeanMap without a bean.boolean
containsKey(Object name)
Deprecated.Returns true if the bean defines a property with the given name.boolean
containsValue(Object value)
Deprecated.Returns true if the bean defines a property whose current value is the given object.protected Object
convertType(Class newType, Object value)
Deprecated.Converts the given value to the given type.protected Object[]
createWriteMethodArguments(Method method, Object value)
Deprecated.Creates an array of parameters to pass to the given mutator method.Iterator
entryIterator()
Deprecated.Convenience method for getting an iterator over the entries.Set
entrySet()
Deprecated.Gets a Set of MapEntry objects that are the mappings for this BeanMap.protected void
firePropertyChange(Object key, Object oldValue, Object newValue)
Deprecated.Called during a successfulput(Object,Object)
operation.Object
get(Object name)
Deprecated.Returns the value of the bean's property with the given name.Object
getBean()
Deprecated.Returns the bean currently being operated on.protected Method
getReadMethod(Object name)
Deprecated.Returns the accessor for the property with the given name.Method
getReadMethod(String name)
Deprecated.Returns the accessor for the property with the given name.Class
getType(String name)
Deprecated.Returns the type of the property with the given name.protected Transformer
getTypeTransformer(Class aType)
Deprecated.Returns a transformer for the given primitive type.protected Method
getWriteMethod(Object name)
Deprecated.Returns the mutator for the property with the given name.Method
getWriteMethod(String name)
Deprecated.Returns the mutator for the property with the given name.Iterator
keyIterator()
Deprecated.Convenience method for getting an iterator over the keys.Set
keySet()
Deprecated.Get the keys for this BeanMap.protected void
logInfo(Exception ex)
Deprecated.Logs the given exception toSystem.out
.protected void
logWarn(Exception ex)
Deprecated.Logs the given exception toSystem.err
.Object
put(Object name, Object value)
Deprecated.Sets the bean property with the given name to the given value.void
putAllWriteable(BeanMap map)
Deprecated.Puts all of the writable properties from the given BeanMap into this BeanMap.protected void
reinitialise()
Deprecated.Reinitializes this bean.void
setBean(Object newBean)
Deprecated.Sets the bean to be operated on by this map.int
size()
Deprecated.Returns the number of properties defined by the bean.String
toString()
Deprecated.Iterator
valueIterator()
Deprecated.Convenience method for getting an iterator over the values.Collection
values()
Deprecated.Returns the values for the BeanMap.-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Field Detail
-
NULL_ARGUMENTS
public static final Object[] NULL_ARGUMENTS
Deprecated.An empty array. Used to invoke accessors via reflection.
-
defaultTransformers
public static HashMap defaultTransformers
Deprecated.Maps primitive Class types to transformers. The transformer transform strings into the appropriate primitive wrapper.
-
-
Constructor Detail
-
BeanMap
public BeanMap()
Deprecated.Constructs a new emptyBeanMap
.
-
BeanMap
public BeanMap(Object bean)
Deprecated.Constructs a newBeanMap
that operates on the specified bean. If the given bean isnull
, then this map will be empty.- Parameters:
bean
- the bean for this map to operate on
-
-
Method Detail
-
toString
public String toString()
Deprecated.- Overrides:
toString
in classAbstractMap
-
clone
public Object clone() throws CloneNotSupportedException
Deprecated.Clone this bean map using the following process:- If there is no underlying bean, return a cloned BeanMap without a bean.
- Since there is an underlying bean, try to instantiate a new bean of the same type using Class.newInstance().
- If the instantiation fails, throw a CloneNotSupportedException
- Clone the bean map and set the newly instantiated bean as the underlying bean for the bean map.
- Copy each property that is both readable and writable from the existing object to a cloned bean map.
- If anything fails along the way, throw a
CloneNotSupportedException.
- Overrides:
clone
in classAbstractMap
- Throws:
CloneNotSupportedException
-
putAllWriteable
public void putAllWriteable(BeanMap map)
Deprecated.Puts all of the writable properties from the given BeanMap into this BeanMap. Read-only and Write-only properties will be ignored.- Parameters:
map
- the BeanMap whose properties to put
-
clear
public void clear()
Deprecated.This method reinitializes the bean map to have default values for the bean's properties. This is accomplished by constructing a new instance of the bean which the map uses as its underlying data source. This behavior forclear()
differs from the Map contract in that the mappings are not actually removed from the map (the mappings for a BeanMap are fixed).- Specified by:
clear
in interfaceMap
- Overrides:
clear
in classAbstractMap
-
containsKey
public boolean containsKey(Object name)
Deprecated.Returns true if the bean defines a property with the given name.The given name must be a
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.
- Specified by:
containsKey
in interfaceMap
- Overrides:
containsKey
in classAbstractMap
- Parameters:
name
- the name of the property to check- Returns:
- false if the given name is null or is not a
String
; false if the bean does not define a property with that name; or true if the bean does define a property with that name
-
containsValue
public boolean containsValue(Object value)
Deprecated.Returns true if the bean defines a property whose current value is the given object.- Specified by:
containsValue
in interfaceMap
- Overrides:
containsValue
in classAbstractMap
- Parameters:
value
- the value to check- Returns:
- false true if the bean has at least one property whose current value is that object, false otherwise
-
get
public Object get(Object name)
Deprecated.Returns the value of the bean's property with the given name.The given name must be a
String
and must not be null; otherwise, this method returnsnull
. 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.
- Specified by:
get
in interfaceMap
- Overrides:
get
in classAbstractMap
- Parameters:
name
- the name of the property whose value to return- Returns:
- the value of the property with that name
-
put
public Object put(Object name, Object value) throws IllegalArgumentException, ClassCastException
Deprecated.Sets the bean property with the given name to the given value.- Specified by:
put
in interfaceMap
- Overrides:
put
in classAbstractMap
- Parameters:
name
- the name of the property to setvalue
- the value to set that property to- Returns:
- the previous value of that property
- Throws:
IllegalArgumentException
- if the given name is null; if the given name is not aString
; if the bean doesn't define a property with that name; or if the bean property with that name is read-onlyClassCastException
-
size
public int size()
Deprecated.Returns the number of properties defined by the bean.- Specified by:
size
in interfaceMap
- Overrides:
size
in classAbstractMap
- Returns:
- the number of properties defined by the bean
-
keySet
public Set keySet()
Deprecated.Get the keys for this BeanMap.Write-only properties are not included in the returned set of property names, although it is possible to set their value and to get their type.
- Specified by:
keySet
in interfaceMap
- Overrides:
keySet
in classAbstractMap
- Returns:
- BeanMap keys. The Set returned by this method is not modifiable.
-
entrySet
public Set entrySet()
Deprecated.Gets a Set of MapEntry objects that are the mappings for this BeanMap.Each MapEntry can be set but not removed.
- Specified by:
entrySet
in interfaceMap
- Specified by:
entrySet
in classAbstractMap
- Returns:
- the unmodifiable set of mappings
-
values
public Collection values()
Deprecated.Returns the values for the BeanMap.- Specified by:
values
in interfaceMap
- Overrides:
values
in classAbstractMap
- Returns:
- values for the BeanMap. The returned collection is not modifiable.
-
getType
public Class getType(String name)
Deprecated.Returns the type of the property with the given name.- Parameters:
name
- the name of the property- Returns:
- the type of the property, or
null
if no such property exists
-
keyIterator
public Iterator keyIterator()
Deprecated.Convenience method for getting an iterator over the keys.Write-only properties will not be returned in the iterator.
- Returns:
- an iterator over the keys
-
valueIterator
public Iterator valueIterator()
Deprecated.Convenience method for getting an iterator over the values.- Returns:
- an iterator over the values
-
entryIterator
public Iterator entryIterator()
Deprecated.Convenience method for getting an iterator over the entries.- Returns:
- an iterator over the entries
-
getBean
public Object getBean()
Deprecated.Returns the bean currently being operated on. The return value may be null if this map is empty.- Returns:
- the bean being operated on by this map
-
setBean
public void setBean(Object newBean)
Deprecated.Sets the bean to be operated on by this map. The given value may be null, in which case this map will be empty.- Parameters:
newBean
- the new bean to operate on
-
getReadMethod
public Method getReadMethod(String name)
Deprecated.Returns the accessor for the property with the given name.- Parameters:
name
- the name of the property- Returns:
- the accessor method for the property, or null
-
getWriteMethod
public Method getWriteMethod(String name)
Deprecated.Returns the mutator for the property with the given name.- Parameters:
name
- the name of the property- Returns:
- the mutator method for the property, or null
-
getReadMethod
protected Method getReadMethod(Object name)
Deprecated.Returns the accessor for the property with the given name.- Parameters:
name
- the name of the property- Returns:
- null if the name is null; null if the name is not a
String
; null if no such property exists; or the accessor method for that property
-
getWriteMethod
protected Method getWriteMethod(Object name)
Deprecated.Returns the mutator for the property with the given name.- Parameters:
name
- the name of the- Returns:
- null if the name is null; null if the name is not a
String
; null if no such property exists; null if the property is read-only; or the mutator method for that property
-
reinitialise
protected void reinitialise()
Deprecated.Reinitializes this bean. Called duringsetBean(Object)
. Does introspection to find properties.
-
firePropertyChange
protected void firePropertyChange(Object key, Object oldValue, Object newValue)
Deprecated.Called during a successfulput(Object,Object)
operation. Default implementation does nothing. Override to be notified of property changes in the bean caused by this map.- Parameters:
key
- the name of the property that changedoldValue
- the old value for that propertynewValue
- the new value for that property
-
createWriteMethodArguments
protected Object[] createWriteMethodArguments(Method method, Object value) throws IllegalAccessException, ClassCastException
Deprecated.Creates an array of parameters to pass to the given mutator method. If the given object is not the right type to pass to the method directly, it will be converted usingconvertType(Class,Object)
.- Parameters:
method
- the mutator methodvalue
- the value to pass to the mutator method- Returns:
- an array containing one object that is either the given value or a transformed value
- Throws:
IllegalAccessException
- ifconvertType(Class,Object)
raises itIllegalArgumentException
- if any other exception is raised byconvertType(Class,Object)
ClassCastException
-
convertType
protected Object convertType(Class newType, Object value) throws InstantiationException, IllegalAccessException, IllegalArgumentException, InvocationTargetException
Deprecated.Converts the given value to the given type. First, reflection is is used to find a public constructor declared by the given class that takes one argument, which must be the precise type of the given value. If such a constructor is found, a new object is created by passing the given value to that constructor, and the newly constructed object is returned.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 anint
.If no special constructor exists and the given type is not a primitive type, this method returns the original value.
- Parameters:
newType
- the type to convert the value tovalue
- the value to convert- Returns:
- the converted value
- Throws:
NumberFormatException
- if newType is a primitive type, and the string representation of the given value cannot be converted to that typeInstantiationException
- if the constructor found with reflection raises itInvocationTargetException
- if the constructor found with reflection raises itIllegalAccessException
- neverIllegalArgumentException
- never
-
getTypeTransformer
protected Transformer getTypeTransformer(Class aType)
Deprecated.Returns a transformer for the given primitive type.- Parameters:
aType
- the primitive type whose transformer to return- Returns:
- a transformer that will convert strings into that type, or null if the given type is not a primitive type
-
logInfo
protected void logInfo(Exception ex)
Deprecated.Logs the given exception toSystem.out
. Used to display warnings while accessing/mutating the bean.- Parameters:
ex
- the exception to log
-
logWarn
protected void logWarn(Exception ex)
Deprecated.Logs the given exception toSystem.err
. Used to display errors while accessing/mutating the bean.- Parameters:
ex
- the exception to log
-
-