public interface

DynaBean

org.apache.commons.beanutils.DynaBean
Known Indirect Subclasses

Class Overview

A DynaBean is a Java object that supports properties whose names and data types, as well as values, may be dynamically modified. To the maximum degree feasible, other components of the BeanUtils package will recognize such beans and treat them as standard JavaBeans for the purpose of retrieving and setting property values.

Summary

Public Methods
abstract boolean contains(String name, String key)
Does the specified mapped property contain a value for the specified key value?
abstract Object get(String name)
Return the value of a simple property with the specified name.
abstract Object get(String name, int index)
Return the value of an indexed property with the specified name.
abstract 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.
abstract DynaClass getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.
abstract void remove(String name, String key)
Remove any existing value for the specified key on the specified mapped property.
abstract void set(String name, String key, Object value)
Set the value of a mapped property with the specified name.
abstract void set(String name, int index, Object value)
Set the value of an indexed property with the specified name.
abstract void set(String name, Object value)
Set the value of a simple property with the specified name.

Public Methods

public abstract 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
Returns
  • true if the mapped property contains a value for the specified key, otherwise false
Throws
IllegalArgumentException if there is no property of the specified name

public abstract 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
Returns
  • The property's value
Throws
IllegalArgumentException if there is no property of the specified name

public abstract 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
Returns
  • The indexed property's value
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

public abstract 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
Returns
  • The mapped property's value
Throws
IllegalArgumentException if there is no property of the specified name
IllegalArgumentException if the specified property exists, but is not mapped

public abstract DynaClass getDynaClass ()

Return the DynaClass instance that describes the set of properties available for this DynaBean.

Returns
  • The associated DynaClass

public abstract 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

public abstract 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

public abstract 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

public abstract 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