org.apache.commons.beanutils

Interface DynaBean

Known Implementing Classes:
BasicDynaBean, ConvertingWrapDynaBean, LazyDynaBean, LazyDynaMap, ResultSetIterator, WrapDynaBean

public interface DynaBean

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.
Version:
$Revision: 1.9 $ $Date: 2004/02/28 13:18:33 $
Authors:
Craig McClanahan
Paulo Gaspar

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.
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.

Method Details

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

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

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

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

getDynaClass

public DynaClass getDynaClass()
Return the DynaClass instance that describes the set of properties available for 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

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

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

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

Copyright (c) 2001-2004 - Apache Software Foundation