public class WrapDynaBean
extends java.lang.Object
implements org.apache.commons.beanutils.DynaBean
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.
Based on the BeanUtils version but provide a Serializable DynaClass.
Modifier and Type | Field and Description |
---|---|
protected WrapDynaClass |
dynaClass
The
DynaClass "base class" that this DynaBean
is associated with. |
protected java.lang.Object |
instance
The JavaBean instance wrapped by this WrapDynaBean.
|
Constructor and Description |
---|
WrapDynaBean(java.lang.Object instance)
Construct a new
DynaBean associated with the specified
JavaBean instance. |
Modifier and Type | Method and Description |
---|---|
boolean |
contains(java.lang.String name,
java.lang.String key)
Does the specified mapped property contain a value for the specified
key value?
|
java.lang.Object |
get(java.lang.String name)
Return the value of a simple property with the specified name.
|
java.lang.Object |
get(java.lang.String name,
int index)
Return the value of an indexed property with the specified name.
|
java.lang.Object |
get(java.lang.String name,
java.lang.String key)
Return the value of a mapped property with the specified name,
or
null if there is no value for the specified key. |
WrapDynaClass |
getDynaClass()
Return the
DynaClass instance that describes the set of
properties available for this DynaBean. |
protected org.apache.commons.beanutils.DynaProperty |
getDynaProperty(java.lang.String name)
Return the property descriptor for the specified property name.
|
java.lang.Object |
getInstance()
Gets the bean instance wrapped by this DynaBean.
|
void |
remove(java.lang.String name,
java.lang.String key)
Remove any existing value for the specified key on the
specified mapped property.
|
void |
set(java.lang.String name,
int index,
java.lang.Object value)
Set the value of an indexed property with the specified name.
|
void |
set(java.lang.String name,
java.lang.Object value)
Set the value of a simple property with the specified name.
|
void |
set(java.lang.String name,
java.lang.String key,
java.lang.Object value)
Set the value of a mapped property with the specified name.
|
protected WrapDynaClass dynaClass
DynaClass
"base class" that this DynaBean
is associated with.protected java.lang.Object instance
public WrapDynaBean(java.lang.Object instance)
DynaBean
associated with the specified
JavaBean instance.instance
- JavaBean instance to be wrappedpublic boolean contains(java.lang.String name, java.lang.String key)
contains
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property to checkkey
- Name of the key to checkjava.lang.IllegalArgumentException
- if there is no property
of the specified namepublic java.lang.Object get(java.lang.String name)
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified namepublic java.lang.Object get(java.lang.String name, int index)
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not indexedjava.lang.IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying propertyjava.lang.NullPointerException
- if no array or List has been
initialized for this propertypublic java.lang.Object get(java.lang.String name, java.lang.String key)
null
if there is no value for the specified key.get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedkey
- Key of the value to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not mappedpublic WrapDynaClass getDynaClass()
DynaClass
instance that describes the set of
properties available for this DynaBean.getDynaClass
in interface org.apache.commons.beanutils.DynaBean
public void remove(java.lang.String name, java.lang.String key)
remove
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property for which a value is to
be removedkey
- Key of the value to be removedjava.lang.IllegalArgumentException
- if there is no property
of the specified namepublic void set(java.lang.String name, java.lang.Object value)
set
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be setorg.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.NullPointerException
- if an attempt is made to set a
primitive property to nullpublic void set(java.lang.String name, int index, java.lang.Object value)
set
in interface org.apache.commons.beanutils.DynaBean
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 setorg.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not indexedjava.lang.IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying propertypublic void set(java.lang.String name, java.lang.String key, java.lang.Object value)
set
in interface org.apache.commons.beanutils.DynaBean
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 setorg.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not mappedpublic java.lang.Object getInstance()
DynaBean
's may
find this useful.DynaBean
protected org.apache.commons.beanutils.DynaProperty getDynaProperty(java.lang.String name)
name
- Name of the property for which to retrieve the descriptorjava.lang.IllegalArgumentException
- if this is not a valid property
name for our DynaClass