org.apache.commons.beanutils
Class WrapDynaBean
java.lang.Object
org.apache.commons.beanutils.WrapDynaBean
- DynaBean
public class WrapDynaBean
extends java.lang.Object
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.
$Revision: 1.9 $ $Date: 2004/02/28 13:18:34 $protected WrapDynaClass | dynaClass - The
DynaClass "base class" that this DynaBean
is associated with.
|
protected Object | instance - The JavaBean instance wrapped by this WrapDynaBean.
|
WrapDynaBean(Object instance) - Construct a new
DynaBean associated with the specified
JavaBean instance.
|
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, String key) - Return the value of a mapped property with the specified name,
or
null if there is no value for the specified key.
|
Object | get(String name, int index) - Return the value of an indexed property with the specified name.
|
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, 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.
|
void | set(String name, int index, Object value) - Set the value of an indexed property with the specified name.
|
dynaClass
protected WrapDynaClass dynaClass
The DynaClass
"base class" that this DynaBean
is associated with.
instance
protected Object instance
The JavaBean instance wrapped by this WrapDynaBean.
WrapDynaBean
public WrapDynaBean(Object instance)
Construct a new DynaBean
associated with the specified
JavaBean instance.
instance
- JavaBean instance to be wrapped
contains
public boolean contains(String name,
String key)
Does the specified mapped property contain a value for the specified
key value?
- contains in interface DynaBean
name
- Name of the property to checkkey
- Name of the key to check
get
public Object get(String name)
Return the value of a simple property with the specified name.
- get in interface DynaBean
name
- Name of the property whose value is to be retrieved
get
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.
- get in interface DynaBean
name
- Name of the property whose value is to be retrievedkey
- Key of the value to be retrieved
get
public Object get(String name,
int index)
Return the value of an indexed property with the specified name.
- get in interface DynaBean
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrieved
getDynaClass
public DynaClass getDynaClass()
Return the DynaClass
instance that describes the set of
properties available for this DynaBean.
- getDynaClass in interface DynaBean
getDynaProperty
protected DynaProperty getDynaProperty(String name)
Return the property descriptor for the specified property name.
name
- Name of the property for which to retrieve the descriptor
getInstance
public 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 using DynaBean
's may
find this useful.
- the java bean Object wrapped by this
DynaBean
remove
public void remove(String name,
String key)
Remove any existing value for the specified key on the
specified mapped property.
- remove in interface DynaBean
name
- Name of the property for which a value is to
be removedkey
- Key of the value to be removed
set
public void set(String name,
Object value)
Set the value of a simple property with the specified name.
- set in interface DynaBean
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be set
set
public void set(String name,
String key,
Object value)
Set the value of a mapped property with the specified name.
- set in interface 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 set
set
public void set(String name,
int index,
Object value)
Set the value of an indexed property with the specified name.
- set in interface 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 set
Copyright (c) 2001-2004 - Apache Software Foundation