org.apache.commons.beanutils

Class WrapDynaBean

Implemented Interfaces:
DynaBean, Serializable
Known Direct Subclasses:
ConvertingWrapDynaBean

public class WrapDynaBean
extends java.lang.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.

Version:
$Revision: 555824 $ $Date: 2007-07-13 01:27:15 +0100 (Fri, 13 Jul 2007) $
Author:
Craig McClanahan

Field Summary

protected WrapDynaClass
dynaClass
The DynaClass "base class" that this DynaBean is associated with.
protected Object
instance
The JavaBean instance wrapped by this WrapDynaBean.

Constructor Summary

WrapDynaBean(Object instance)
Construct a new DynaBean associated with the specified JavaBean instance.

Method Summary

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.

Field Details

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.

Constructor Details

WrapDynaBean

public WrapDynaBean(Object instance)
Construct a new DynaBean associated with the specified JavaBean instance.
Parameters:
instance - JavaBean instance to be wrapped

Method Details

contains

public boolean contains(String name,
                        String key)
Does the specified mapped property contain a value for the specified key value?
Specified by:
contains in interface DynaBean
Parameters:
name - Name of the property to check
key - Name of the key to check
Returns:
true if the mapped property contains a value for the specified key, otherwise false

get

public Object get(String name)
Return the value of a simple property with the specified name.
Specified by:
get in interface DynaBean
Parameters:
name - Name of the property whose value is to be retrieved
Returns:
The property's value

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.
Specified by:
get in interface DynaBean
Parameters:
name - Name of the property whose value is to be retrieved
key - Key of the value to be retrieved
Returns:
The mapped property's value

get

public Object get(String name,
                  int index)
Return the value of an indexed property with the specified name.
Specified by:
get in interface DynaBean
Parameters:
name - Name of the property whose value is to be retrieved
index - Index of the value to be retrieved
Returns:
The indexed property's value

getDynaClass

public DynaClass getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.
Specified by:
getDynaClass in interface DynaBean
Returns:
The associated DynaClass

getDynaProperty

protected DynaProperty getDynaProperty(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

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.
Returns:
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.
Specified by:
remove in interface DynaBean
Parameters:
name - Name of the property for which a value is to be removed
key - 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.
Specified by:
set in interface DynaBean
Parameters:
name - Name of the property whose value is to be set
value - 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.
Specified by:
set in interface DynaBean
Parameters:
name - Name of the property whose value is to be set
key - Key of the property to be set
value - 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.
Specified by:
set in interface DynaBean
Parameters:
name - Name of the property whose value is to be set
index - Index of the property to be set
value - Value to which this property is to be set

Copyright (c) 2001-2007 - Apache Software Foundation