| java.lang.Object
 org.apache.commons.beanutils.WrapDynaBean
All known Subclasses: org.apache.commons.beanutils.ConvertingWrapDynaBean,
| WrapDynaBean | | public class WrapDynaBean implements DynaBean,Serializable(Code) | | 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.
author:
Craig McClanahan
version:
$Revision: 555824 $ $Date: 2007-07-13 01:27:15 +0100 (Fri, 13 Jul 2007) $ |
| Field Summary | |
| protected transient WrapDynaClass | dynaClass
The DynaClass "base class" that this DynaBean
is associated with. | | protected Object | instance
The JavaBean instance wrapped by this WrapDynaBean. |
| Constructor Summary | |
| public | WrapDynaBean(Object instance)
Construct a new DynaBean associated with the specified
JavaBean instance. |
| Method Summary | |
| public boolean | contains(String name, String key)
| | public Object | get(String name)
Return the value of a simple property with the specified name. | | public Object | get(String name, int index)
Return the value of an indexed property with the specified name. | | public Object | get(String name, String key)
Return the value of a mapped property with the specified name,
or null if there is no value for the specified key. | | public DynaClass | getDynaClass()
Return the DynaClass 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. | | public Object | getInstance()
Gets the bean instance wrapped by this DynaBean. | | public void | remove(String name, String key)
Remove any existing value for the specified key on the
specified mapped property. | | public void | set(String name, Object value)
Set the value of a simple property with the specified name. | | public void | set(String name, int index, Object value)
Set the value of an indexed property with the specified name. | | public void | set(String name, String key, Object value)
Set the value of a mapped property with the specified name. |
| dynaClass | | protected transient WrapDynaClass dynaClass(Code) | | The DynaClass "base class" that this DynaBean
is associated with.
|
| instance | | protected Object instance(Code) | | The JavaBean instance wrapped by this WrapDynaBean.
|
| WrapDynaBean | | public WrapDynaBean(Object instance)(Code) | | Construct a new DynaBean associated with the specified
JavaBean instance.
Parameters:
instance - JavaBean instance to be wrapped |
| contains | | public boolean contains(String name, String key)(Code) | | Does the specified mapped property contain a value for the specified
key value?
Parameters:
name - Name of the property to check
Parameters:
key - Name of the key to check true if the mapped property contains a value forthe specified key, otherwise false
exception:
IllegalArgumentException - if there is no propertyof the specified name |
| get | | public Object get(String name)(Code) | | Return the value of a simple property with the specified name.
Parameters:
name - Name of the property whose value is to be retrieved The property's value
exception:
IllegalArgumentException - if there is no propertyof the specified name |
| get | | public Object get(String name, int index)(Code) | | Return the value of an indexed property with the specified name.
Parameters:
name - Name of the property whose value is to be retrieved
Parameters:
index - Index of the value to be retrieved The indexed property's value
exception:
IllegalArgumentException - if there is no propertyof the specified name
exception:
IllegalArgumentException - if the specified propertyexists, but is not indexed
exception:
IndexOutOfBoundsException - if the specified indexis outside the range of the underlying property
exception:
NullPointerException - if no array or List has beeninitialized for this property |
| get | | public Object get(String name, String key)(Code) | | Return the value of a mapped property with the specified name,
or null if there is no value for the specified key.
Parameters:
name - Name of the property whose value is to be retrieved
Parameters:
key - Key of the value to be retrieved The mapped property's value
exception:
IllegalArgumentException - if there is no propertyof the specified name
exception:
IllegalArgumentException - if the specified propertyexists, but is not mapped |
| getDynaClass | | public DynaClass getDynaClass()(Code) | | Return the DynaClass instance that describes the set of
properties available for this DynaBean.
The associated DynaClass |
| getDynaProperty | | protected DynaProperty getDynaProperty(String name)(Code) | | Return the property descriptor for the specified property name.
Parameters:
name - Name of the property for which to retrieve the descriptor The descriptor for the specified property
exception:
IllegalArgumentException - if this is not a valid propertyname for our DynaClass |
| getInstance | | public Object getInstance()(Code) | | 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 using DynaBean's may
find this useful.
the java bean Object wrapped by this DynaBean |
| remove | | public void remove(String name, String key)(Code) | | Remove any existing value for the specified key on the
specified mapped property.
Parameters:
name - Name of the property for which a value is tobe removed
Parameters:
key - Key of the value to be removed
exception:
IllegalArgumentException - if there is no propertyof the specified name |
| set | | public void set(String name, Object value)(Code) | | Set the value of a simple property with the specified name.
Parameters:
name - Name of the property whose value is to be set
Parameters:
value - Value to which this property is to be set
exception:
ConversionException - if the specified value cannot beconverted to the type required for this property
exception:
IllegalArgumentException - if there is no propertyof the specified name
exception:
NullPointerException - if an attempt is made to set aprimitive property to null |
| set | | public void set(String name, int index, Object value)(Code) | | Set the value of an indexed property with the specified name.
Parameters:
name - Name of the property whose value is to be set
Parameters:
index - Index of the property to be set
Parameters:
value - Value to which this property is to be set
exception:
ConversionException - if the specified value cannot beconverted to the type required for this property
exception:
IllegalArgumentException - if there is no propertyof the specified name
exception:
IllegalArgumentException - if the specified propertyexists, but is not indexed
exception:
IndexOutOfBoundsException - if the specified indexis outside the range of the underlying property |
| set | | public void set(String name, String key, Object value)(Code) | | Set the value of a mapped property with the specified name.
Parameters:
name - Name of the property whose value is to be set
Parameters:
key - Key of the property to be set
Parameters:
value - Value to which this property is to be set
exception:
ConversionException - if the specified value cannot beconverted to the type required for this property
exception:
IllegalArgumentException - if there is no propertyof the specified name
exception:
IllegalArgumentException - if the specified propertyexists, but is not mapped |
|
|