public class WrapDynaBean extends Object implements DynaBean, Serializable
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.
| Modifier and Type | Field and Description |
|---|---|
protected WrapDynaClass |
dynaClass
The
DynaClass "base class" that this DynaBean
is associated with. |
protected Object |
instance
The JavaBean instance wrapped by this WrapDynaBean.
|
| Constructor and Description |
|---|
WrapDynaBean(Object instance)
Construct a new
DynaBean associated with the specified
JavaBean instance. |
WrapDynaBean(Object instance,
WrapDynaClass cls)
Creates a new instance of
WrapDynaBean, associates it with the specified
JavaBean instance, and initializes the bean's DynaClass. |
| Modifier and Type | Method and Description |
|---|---|
boolean |
contains(String name,
String key)
Does the specified mapped property contain a value for the specified
key value?
|
Object |
get(String name)
Return the value of a simple property with the specified name.
|
Object |
get(String name,
int index)
Return the value of an indexed property with the specified name.
|
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. |
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.
|
Object |
getInstance()
Gets the bean instance wrapped by this DynaBean.
|
void |
remove(String name,
String key)
Remove any existing value for the specified key on the
specified mapped property.
|
void |
set(String name,
int index,
Object value)
Set the value of an indexed property with the specified name.
|
void |
set(String name,
Object value)
Set the value of a simple property with the specified name.
|
void |
set(String name,
String key,
Object value)
Set the value of a mapped property with the specified name.
|
protected transient WrapDynaClass dynaClass
DynaClass "base class" that this DynaBean
is associated with.protected Object instance
public WrapDynaBean(Object instance)
DynaBean associated with the specified
JavaBean instance.instance - JavaBean instance to be wrappedpublic WrapDynaBean(Object instance, WrapDynaClass cls)
WrapDynaBean, associates it with the specified
JavaBean instance, and initializes the bean's DynaClass. Using this
constructor this WrapDynaBean instance can be assigned a class which has
been configured externally. If no WrapDynaClass is provided, a new one is
created using a standard mechanism.instance - JavaBean instance to be wrappedcls - the optional WrapDynaClass to be used for this beanpublic boolean contains(String name, String key)
contains in interface DynaBeanname - Name of the property to checkkey - Name of the key to checktrue if the mapped property contains a value for
the specified key, otherwise falseIllegalArgumentException - if there is no property
of the specified namepublic Object get(String name)
get in interface DynaBeanname - Name of the property whose value is to be retrievedIllegalArgumentException - if there is no property
of the specified namepublic Object get(String name, int index)
get in interface DynaBeanname - Name of the property whose value is to be retrievedindex - Index of the value to be retrievedIllegalArgumentException - 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 propertypublic Object get(String name, String key)
null if there is no value for the specified key.get in interface DynaBeanname - Name of the property whose value is to be retrievedkey - Key of the value to be retrievedIllegalArgumentException - if there is no property
of the specified nameIllegalArgumentException - if the specified property
exists, but is not mappedpublic DynaClass getDynaClass()
DynaClass instance that describes the set of
properties available for this DynaBean.getDynaClass in interface DynaBeanpublic void remove(String name, String key)
remove in interface DynaBeanname - Name of the property for which a value is to
be removedkey - Key of the value to be removedIllegalArgumentException - if there is no property
of the specified namepublic void set(String name, Object value)
set in interface DynaBeanname - Name of the property whose value is to be setvalue - Value to which this property is to be setConversionException - 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 nullpublic void set(String name, int index, Object value)
set in interface DynaBeanname - 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 setConversionException - 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 propertypublic void set(String name, String key, Object value)
set in interface DynaBeanname - 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 setConversionException - 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 mappedpublic Object getInstance()
DynaBean's may
find this useful.DynaBeanprotected DynaProperty getDynaProperty(String name)
name - Name of the property for which to retrieve the descriptorIllegalArgumentException - if this is not a valid property
name for our DynaClassCopyright © 2000–2014 The Apache Software Foundation. All rights reserved.