Package org.apache.commons.beanutils
Class BasicDynaBean
java.lang.Object
org.apache.commons.beanutils.BasicDynaBean
- All Implemented Interfaces:
Serializable
,DynaBean
Minimal implementation of the DynaBean
interface. Can be
used as a convenience base class for more sophisticated implementations.
IMPLEMENTATION NOTE - Instances of this class that are accessed from multiple threads simultaneously need to be synchronized.
IMPLEMENTATION NOTE - Instances of this class can be
successfully serialized and deserialized ONLY if all
property values are Serializable
.
- Version:
- $Id$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DynaClass
TheDynaClass
"base class" that this DynaBean is associated with.Map decorator for this DynaBeanThe set of property values for this DynaBean, keyed by property name. -
Constructor Summary
ConstructorsConstructorDescriptionBasicDynaBean
(DynaClass dynaClass) Construct a newDynaBean
associated with the specifiedDynaClass
instance. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Does the specified mapped property contain a value for the specified key value?Return the value of a simple property with the specified name.Return the value of an indexed property with the specified name.Return the value of a mapped property with the specified name, ornull
if there is no value for the specified key.Return theDynaClass
instance that describes the set of properties available for this DynaBean.protected DynaProperty
getDynaProperty
(String name) Return the property descriptor for the specified property name.getMap()
Return a Map representation of this DynaBean.protected boolean
isAssignable
(Class<?> dest, Class<?> source) Is an object of the source class assignable to the destination class?void
Remove any existing value for the specified key on the specified mapped property.void
Set the value of an indexed property with the specified name.void
Set the value of a simple property with the specified name.void
Set the value of a mapped property with the specified name.
-
Field Details
-
dynaClass
TheDynaClass
"base class" that this DynaBean is associated with. -
values
The set of property values for this DynaBean, keyed by property name. -
mapDecorator
Map decorator for this DynaBean
-
-
Constructor Details
-
BasicDynaBean
Construct a newDynaBean
associated with the specifiedDynaClass
instance.- Parameters:
dynaClass
- The DynaClass we are associated with
-
-
Method Details
-
getMap
Return a Map representation of this DynaBean. This, for example, could be used in JSTL in the following way to access a DynaBean'sfooProperty
:${myDynaBean.map.fooProperty}
- Returns:
- a Map representation of this DynaBean
- Since:
- 1.8.0
-
contains
Does the specified mapped property contain a value for the specified key value?- Specified by:
contains
in interfaceDynaBean
- Parameters:
name
- Name of the property to checkkey
- Name of the key to check- Returns:
true
if the mapped property contains a value for the specified key, otherwisefalse
- Throws:
IllegalArgumentException
- if there is no property of the specified name
-
get
Return the value of a simple property with the specified name.- Specified by:
get
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be retrieved- Returns:
- The property's value
- Throws:
IllegalArgumentException
- if there is no property of the specified name
-
get
Return the value of an indexed property with the specified name.- Specified by:
get
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrieved- Returns:
- The indexed property's value
- Throws:
IllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not indexedIndexOutOfBoundsException
- if the specified index is outside the range of the underlying propertyNullPointerException
- if no array or List has been initialized for this property
-
get
Return the value of a mapped property with the specified name, ornull
if there is no value for the specified key.- Specified by:
get
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be retrievedkey
- Key of the value to be retrieved- Returns:
- The mapped property's value
- Throws:
IllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not mapped
-
getDynaClass
Return theDynaClass
instance that describes the set of properties available for this DynaBean.- Specified by:
getDynaClass
in interfaceDynaBean
- Returns:
- The associated DynaClass
-
remove
Remove any existing value for the specified key on the specified mapped property.- Specified by:
remove
in interfaceDynaBean
- Parameters:
name
- Name of the property for which a value is to be removedkey
- Key of the value to be removed- Throws:
IllegalArgumentException
- if there is no property of the specified name
-
set
Set the value of a simple property with the specified name.- Specified by:
set
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be set- Throws:
ConversionException
- if the specified value cannot be converted to the type required for this propertyIllegalArgumentException
- if there is no property of the specified nameNullPointerException
- if an attempt is made to set a primitive property to null
-
set
Set the value of an indexed property with the specified name.- Specified by:
set
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be setindex
- Index of the property to be setvalue
- Value to which this property is to be set- Throws:
ConversionException
- if the specified value cannot be converted to the type required for this propertyIllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not indexedIndexOutOfBoundsException
- if the specified index is outside the range of the underlying property
-
set
Set the value of a mapped property with the specified name.- Specified by:
set
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be setkey
- Key of the property to be setvalue
- Value to which this property is to be set- Throws:
ConversionException
- if the specified value cannot be converted to the type required for this propertyIllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not mapped
-
getDynaProperty
Return the property descriptor for the specified property name.- Parameters:
name
- Name of the property for which to retrieve the descriptor- Returns:
- The property descriptor
- Throws:
IllegalArgumentException
- if this is not a valid property name for our DynaClass
-
isAssignable
Is an object of the source class assignable to the destination class?- Parameters:
dest
- Destination classsource
- Source class- Returns:
true
if the source class is assignable to the destination class, otherwisefalse
-