Package org.apache.commons.beanutils
Class WrapDynaBean
- java.lang.Object
-
- org.apache.commons.beanutils.WrapDynaBean
-
- All Implemented Interfaces:
java.io.Serializable
,DynaBean
- Direct Known Subclasses:
ConvertingWrapDynaBean
public class WrapDynaBean extends java.lang.Object implements DynaBean, java.io.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()
andremove()
methods.- Version:
- $Id: WrapDynaBean.java 1747095 2016-06-07 00:27:52Z ggregory $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected WrapDynaClass
dynaClass
TheDynaClass
"base class" that this DynaBean is associated with.protected java.lang.Object
instance
The JavaBean instance wrapped by this WrapDynaBean.
-
Constructor Summary
Constructors Constructor Description WrapDynaBean(java.lang.Object instance)
Construct a newDynaBean
associated with the specified JavaBean instance.WrapDynaBean(java.lang.Object instance, WrapDynaClass cls)
Creates a new instance ofWrapDynaBean
, associates it with the specified JavaBean instance, and initializes the bean'sDynaClass
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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, ornull
if there is no value for the specified key.DynaClass
getDynaClass()
Return theDynaClass
instance that describes the set of properties available for this DynaBean.protected 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.
-
-
-
Field Detail
-
dynaClass
protected transient WrapDynaClass dynaClass
TheDynaClass
"base class" that this DynaBean is associated with.
-
instance
protected java.lang.Object instance
The JavaBean instance wrapped by this WrapDynaBean.
-
-
Constructor Detail
-
WrapDynaBean
public WrapDynaBean(java.lang.Object instance)
Construct a newDynaBean
associated with the specified JavaBean instance.- Parameters:
instance
- JavaBean instance to be wrapped
-
WrapDynaBean
public WrapDynaBean(java.lang.Object instance, WrapDynaClass cls)
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 Detail
-
contains
public boolean contains(java.lang.String name, java.lang.String key)
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:
java.lang.IllegalArgumentException
- if there is no property of the specified name
-
get
public java.lang.Object get(java.lang.String name)
Return the value of a simple property with the specified name.
-
get
public java.lang.Object get(java.lang.String name, int index)
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:
java.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 property
-
get
public java.lang.Object get(java.lang.String name, java.lang.String key)
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:
java.lang.IllegalArgumentException
- if there is no property of the specified namejava.lang.IllegalArgumentException
- if the specified property exists, but is not mapped
-
getDynaClass
public DynaClass getDynaClass()
Return theDynaClass
instance that describes the set of properties available for this DynaBean.- Specified by:
getDynaClass
in interfaceDynaBean
- Returns:
- The associated DynaClass
-
remove
public void remove(java.lang.String name, java.lang.String key)
Remove any existing value for the specified key on the specified mapped property.
-
set
public void set(java.lang.String name, java.lang.Object value)
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 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 null
-
set
public void set(java.lang.String name, int index, java.lang.Object value)
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 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 property
-
set
public 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.- 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 propertyjava.lang.IllegalArgumentException
- if there is no property of the specified namejava.lang.IllegalArgumentException
- if the specified property exists, but is not mapped
-
getInstance
public java.lang.Object 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
protected DynaProperty getDynaProperty(java.lang.String name)
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:
java.lang.IllegalArgumentException
- if this is not a valid property name for our DynaClass
-
-