| java.lang.Object
 org.apache.struts.action.ActionForm
org.apache.struts.action.DynaActionForm
All known Subclasses: org.apache.struts.validator.DynaValidatorForm,
| DynaActionForm | | public class DynaActionForm extends ActionForm implements DynaBean(Code) | | Specialized subclass of ActionForm that allows the creation
of form beans with dynamic sets of properties, without requiring the
developer to create a Java class for each type of form bean.
USAGE NOTE - Since Struts 1.1, the reset
method no longer initializes property values to those specified in
<form-property> elements in the Struts module
configuration file. If you wish to utilize that behavior, the simplest
solution is to subclass DynaActionForm and call the
initialize method inside it.
version:
$Rev: 471754 $ $Date: 2005-11-12 11:52:08 -0500 (Sat, 12 Nov 2005)
version:
$
since:
Struts 1.1 |
| Method Summary | |
| public boolean | contains(String name, String key)
| | public Object | get(String name)
| | public Object | get(String name, int index)
Return the value of an indexed property with the specified name. | | 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. | | public DynaClass | getDynaClass()
| | protected DynaProperty | getDynaProperty(String name)
| | public Map | getMap()
Returns the Map containing the property values. | | public String | getString(String name)
Return the value of a String property with the
specified name. | | public String[] | getStrings(String name)
Return the value of a String[] property with the
specified name. | | public void | initialize(ActionMapping mapping)
| | public void | initialize(FormBeanConfig config)
| | protected boolean | isDynaAssignable(Class dest, Class source)
| | public void | remove(String name, String key)
| | public void | reset(ActionMapping mapping, ServletRequest request)
Reset bean properties to their default state, as needed. | | public void | reset(ActionMapping mapping, HttpServletRequest request)
| | public void | set(String name, Object value)
| | public void | set(String name, int index, Object value)
| | public void | set(String name, String key, Object value)
| | void | setDynaActionFormClass(DynaActionFormClass dynaClass)
| | public String | toString()
|
| dynaValues | | protected HashMap dynaValues(Code) | | The set of property values for this DynaActionForm,
keyed by property name.
|
| contains | | public boolean contains(String name, String key)(Code) | | Indicates if the specified mapped property contain a value for the
specified key value.
Parameters:
name - Name of the property to check
Parameters:
key - Name of the key to check true if the specified mapped property contains avalue for the specified key value; trueotherwise.
throws:
NullPointerException - if there is no property of thespecified name
throws:
IllegalArgumentException - if there is no mapped property of thespecified name |
| get | | public Object get(String name)(Code) | | Return the value of a simple property with the specified name.
Parameters:
name - Name of the property whose value is to be retrieved The value of a simple property with the specified name.
throws:
IllegalArgumentException - if there is no property of thespecified name
throws:
NullPointerException - if the type specified for the propertyis invalid |
| get | | public Object get(String name, int index)(Code) | | Return the value of an indexed property with the specified name.
Parameters:
name - Name of the property whose value is to be retrieved
Parameters:
index - Index of the value to be retrieved The value of an indexed property with the specified name.
throws:
IllegalArgumentException - if there is no property of thespecified name
throws:
IllegalArgumentException - if the specified property exists, butis not indexed
throws:
NullPointerException - if no array or List has beeninitialized for this property |
| get | | public Object get(String name, String key)(Code) | | 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
Parameters:
key - Key of the value to be retrieved The value of a mapped property with the specified name, ornull if there is no value for the specified key.
throws:
NullPointerException - if there is no property of thespecified name
throws:
IllegalArgumentException - if the specified property exists, butis not mapped |
| getDynaClass | | public DynaClass getDynaClass()(Code) | | Return the DynaClass instance that describes the set of
properties available for this DynaBean.
The DynaClass instance that describes the set ofproperties available for this DynaBean. |
| getDynaProperty | | protected DynaProperty getDynaProperty(String name)(Code) | | Return the property descriptor for the specified property name.
Parameters:
name - Name of the property for which to retrieve the descriptor The property descriptor for the specified property name.
throws:
IllegalArgumentException - if this is not a valid property namefor our DynaClass |
| getMap | | public Map getMap()(Code) | | Returns the Map containing the property values. This is
done mostly to facilitate accessing the DynaActionForm
through JavaBeans accessors, in order to use the JavaServer Pages
Standard Tag Library (JSTL).
For instance, the normal JSTL EL syntax for accessing an
ActionForm would be something like this:
${formbean.prop}
The JSTL EL syntax for accessing a DynaActionForm looks
something like this (because of the presence of this
getMap() method):
${dynabean.map.prop}
The Map containing the property values. |
| getString | | public String getString(String name)(Code) | | Return the value of a String property with the
specified name. This is equivalent to calling (String)
dynaForm.get(name).
Parameters:
name - Name of the property whose value is to be retrieved. The value of a String property with the specifiedname.
throws:
IllegalArgumentException - if there is no property of thespecified name
throws:
NullPointerException - if the type specified for the propertyis invalid
throws:
ClassCastException - if the property is not a String.
since:
Struts 1.2 |
| getStrings | | public String[] getStrings(String name)(Code) | | Return the value of a String[] property with the
specified name. This is equivalent to calling (String[])
dynaForm.get(name).
Parameters:
name - Name of the property whose value is to be retrieved. The value of a String[] property with thespecified name.
throws:
IllegalArgumentException - if there is no property of thespecified name
throws:
NullPointerException - if the type specified for the propertyis invalid
throws:
ClassCastException - if the property is not a String[].
since:
Struts 1.2 |
| initialize | | public void initialize(ActionMapping mapping)(Code) | | Initialize all bean properties to their initial values, as specified
in the
FormPropertyConfig elements associated with the
definition of this DynaActionForm.
Parameters:
mapping - The mapping used to select this instance |
| initialize | | public void initialize(FormBeanConfig config)(Code) | | Initialize the specified form bean.
Parameters:
config - The configuration for the form bean to initialize. |
| isDynaAssignable | | protected boolean isDynaAssignable(Class dest, Class source)(Code) | | Indicates if an object of the source class is assignable to the
destination class.
Parameters:
dest - Destination class
Parameters:
source - Source class true if the source is assignable to thedestination; false otherwise. |
| remove | | public void remove(String name, String key)(Code) | | 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
Parameters:
key - Key of the value to be removed
throws:
NullPointerException - if there is no property of thespecified name
throws:
IllegalArgumentException - if there is no mapped property of thespecified name |
| reset | | public void reset(ActionMapping mapping, ServletRequest request)(Code) | | Reset bean properties to their default state, as needed. This method
is called before the properties are repopulated by the controller.
The default implementation attempts to forward to the HTTP version
of this method.
Parameters:
mapping - The mapping used to select this instance
Parameters:
request - The servlet request we are processing |
| reset | | public void reset(ActionMapping mapping, HttpServletRequest request)(Code) | | Reset the properties to their initial value if their
reset configuration is set to true or if
reset is set to a list of HTTP request methods that
includes the method of given request object.
Parameters:
mapping - The mapping used to select this instance
Parameters:
request - The servlet request we are processing |
| set | | public void set(String name, Object value)(Code) | | Set the value of a simple property with the specified name.
Parameters:
name - Name of the property whose value is to be set
Parameters:
value - Value to which this property is to be set
throws:
ConversionException - if the specified value cannot beconverted to the type required forthis property
throws:
IllegalArgumentException - if there is no property of thespecified name
throws:
NullPointerException - if the type specified for the propertyis invalid
throws:
NullPointerException - if an attempt is made to set aprimitive property to null |
| set | | public void set(String name, int index, Object value)(Code) | | Set the value of an indexed property with the specified name.
Parameters:
name - Name of the property whose value is to be set
Parameters:
index - Index of the property to be set
Parameters:
value - Value to which this property is to be set
throws:
ConversionException - if the specified value cannot beconverted to the type required forthis property
throws:
NullPointerException - if there is no property of thespecified name
throws:
IllegalArgumentException - if the specified property exists, butis not indexed
throws:
IndexOutOfBoundsException - if the specified index is outside therange of the underlying property |
| set | | public void set(String name, String key, Object value)(Code) | | Set the value of a mapped property with the specified name.
Parameters:
name - Name of the property whose value is to be set
Parameters:
key - Key of the property to be set
Parameters:
value - Value to which this property is to be set
throws:
NullPointerException - if there is no property of thespecified name
throws:
IllegalArgumentException - if the specified property exists, butis not mapped |
| setDynaActionFormClass | | void setDynaActionFormClass(DynaActionFormClass dynaClass)(Code) | | Set the DynaActionFormClass instance with which we are
associated.
Parameters:
dynaClass - The DynaActionFormClass instance for this bean |
| toString | | public String toString()(Code) | | Render a String representation of this object.
A string representation of this object. |
|
|