org.apache.commons.beanutils

Class WrapDynaBean

public class WrapDynaBean extends Object implements 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.

Version: $Revision: 1.9 $ $Date: 2004/02/28 13:18:34 $

Author: Craig McClanahan

Field Summary
protected WrapDynaClassdynaClass
The DynaClass "base class" that this DynaBean is associated with.
protected Objectinstance
The JavaBean instance wrapped by this WrapDynaBean.
Constructor Summary
WrapDynaBean(Object instance)
Construct a new DynaBean associated with the specified JavaBean instance.
Method Summary
booleancontains(String name, String key)
Does the specified mapped property contain a value for the specified key value?
Objectget(String name)
Return the value of a simple property with the specified name.
Objectget(String name, int index)
Return the value of an indexed property with the specified name.
Objectget(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.
DynaClassgetDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.
protected DynaPropertygetDynaProperty(String name)
Return the property descriptor for the specified property name.
ObjectgetInstance()
Gets the bean instance wrapped by this DynaBean.
voidremove(String name, String key)
Remove any existing value for the specified key on the specified mapped property.
voidset(String name, Object value)
Set the value of a simple property with the specified name.
voidset(String name, int index, Object value)
Set the value of an indexed property with the specified name.
voidset(String name, String key, Object value)
Set the value of a mapped property with the specified name.

Field Detail

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 Detail

WrapDynaBean

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

Parameters: instance JavaBean instance to be wrapped

Method Detail

contains

public boolean contains(String name, String key)
Does the specified mapped property contain a value for the specified key value?

Parameters: name Name of the property to check key Name of the key to check

Throws: IllegalArgumentException if there is no property of the specified name

get

public Object get(String name)
Return the value of a simple property with the specified name.

Parameters: name Name of the property whose value is to be retrieved

Throws: IllegalArgumentException if there is no property of the specified name

get

public Object get(String name, int index)
Return the value of an indexed property with the specified name.

Parameters: name Name of the property whose value is to be retrieved index Index of the value to be retrieved

Throws: IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not indexed IndexOutOfBoundsException if the specified index is outside the range of the underlying property NullPointerException if no array or List has been initialized for this property

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.

Parameters: name Name of the property whose value is to be retrieved key Key of the value to be retrieved

Throws: IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not mapped

getDynaClass

public DynaClass getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.

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

Throws: IllegalArgumentException if this is not a valid property name for our DynaClass

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.

Parameters: name Name of the property for which a value is to be removed key Key of the value to be removed

Throws: IllegalArgumentException if there is no property of the specified name

set

public void set(String name, Object value)
Set the value of a simple property with the specified name.

Parameters: name Name of the property whose value is to be set value Value to which this property is to be set

Throws: ConversionException if the specified value cannot be converted to the type required for this property IllegalArgumentException if there is no property of the specified name NullPointerException if an attempt is made to set a primitive property to null

set

public void set(String name, int index, Object value)
Set the value of an indexed property with the specified name.

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

Throws: ConversionException if the specified value cannot be converted to the type required for this property IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not indexed IndexOutOfBoundsException if the specified index is outside the range of the underlying property

set

public void set(String name, String key, Object value)
Set the value of a mapped property with the specified name.

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

Throws: ConversionException if the specified value cannot be converted to the type required for this property IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not mapped

Copyright (c) 2001-2004 - Apache Software Foundation