Package org.apache.commons.beanutils
Class WrapDynaBean
java.lang.Object
org.apache.commons.beanutils.WrapDynaBean
- All Implemented Interfaces:
Serializable
,DynaBean
- Direct Known Subclasses:
ConvertingWrapDynaBean
Implementation of DynaBean
that wraps a standard JavaBean
instance, so that DynaBean APIs can be used to access its properties.
The most common use cases for this class involve wrapping an existing java bean.
(This makes it different from the typical use cases for other DynaBean
's.)
For example:
Object aJavaBean = ...;
...
DynaBean db = new WrapDynaBean(aJavaBean);
...
IMPLEMENTATION NOTE - This implementation does not
support the contains()
and remove()
methods.
- Version:
- $Id$
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected WrapDynaClass
TheDynaClass
"base class" that this DynaBean is associated with.protected Object
The JavaBean instance wrapped by this WrapDynaBean. -
Constructor Summary
ConstructorsConstructorDescriptionWrapDynaBean
(Object instance) Construct a newDynaBean
associated with the specified JavaBean instance.WrapDynaBean
(Object instance, WrapDynaClass cls) Creates a new instance ofWrapDynaBean
, associates it with the specified JavaBean instance, and initializes the bean'sDynaClass
. -
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.Gets the bean instance wrapped by this DynaBean.private PropertyUtilsBean
Returns thePropertyUtilsBean
instance to be used for accessing properties.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. -
instance
The JavaBean instance wrapped by this WrapDynaBean.
-
-
Constructor Details
-
WrapDynaBean
Construct a newDynaBean
associated with the specified JavaBean instance.- Parameters:
instance
- JavaBean instance to be wrapped
-
WrapDynaBean
Creates a new instance ofWrapDynaBean
, associates it with the specified JavaBean instance, and initializes the bean'sDynaClass
. Using this constructor thisWrapDynaBean
instance can be assigned a class which has been configured externally. If noWrapDynaClass
is provided, a new one is created using a standard mechanism.- Parameters:
instance
- JavaBean instance to be wrappedcls
- the optionalWrapDynaClass
to be used for this bean- Since:
- 1.9
-
-
Method Details
-
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, otherwise
false
- 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
-
getInstance
Gets the bean instance wrapped by this DynaBean. For most common use cases, this object should already be known and this method safely be ignored. But some creators of frameworks usingDynaBean
's may find this useful.- Returns:
- the java bean Object wrapped by this
DynaBean
-
getDynaProperty
Return the property descriptor for the specified property name.- Parameters:
name
- Name of the property for which to retrieve the descriptor- Returns:
- The descriptor for the specified property
- Throws:
IllegalArgumentException
- if this is not a valid property name for our DynaClass
-
getPropertyUtils
Returns thePropertyUtilsBean
instance to be used for accessing properties. If available, this object is obtained from the associatedWrapDynaClass
.- Returns:
- the associated
PropertyUtilsBean
-