org.apache.struts.action
public class DynaActionForm extends ActionForm implements DynaBean
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.
Since: Struts 1.1
Version: $Rev: 168012 $ $Date: 2005-05-03 23:39:10 +0100 (Tue, 03 May 2005) $
Field Summary | |
---|---|
protected DynaActionFormClass | dynaClass The |
protected HashMap | dynaValues The set of property values for this |
Method Summary | |
---|---|
boolean | contains(String name, String key) Indicates if 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, int index) Return the value of an indexed property with the specified name. |
Object | get(String name, String key) Return the value of a mapped property with the specified name,
or |
DynaClass | getDynaClass() Return the |
protected DynaProperty | getDynaProperty(String name) Return the property descriptor for the specified property name. |
Map | getMap() Returns the |
String | getString(String name) Return the value of a |
String[] | getStrings(String name) Return the value of a |
void | initialize(ActionMapping mapping) Initialize all bean properties to their initial values, as specified
in the {@link FormPropertyConfig} elements associated with the
definition of this |
void | initialize(FormBeanConfig config) |
protected boolean | isDynaAssignable(Class dest, Class source) Indicates if an object of the source class is assignable to the destination class. |
void | remove(String name, String key) Remove any existing value for the specified key on the specified mapped property. |
void | reset(ActionMapping mapping, ServletRequest request) Reset bean properties to their default state, as needed. |
void | reset(ActionMapping mapping, HttpServletRequest request) Reset bean properties to their default state, as needed. |
void | set(String name, Object value) Set the value of a simple property with the specified name. |
void | set(String name, int index, Object value) Set the value of an indexed 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 | setDynaActionFormClass(DynaActionFormClass dynaClass) Set the |
String | toString() Render a String representation of this object. |
The DynaActionFormClass
with which we are associated.
The set of property values for this DynaActionForm
,
keyed by property name.
Indicates if 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
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 NullPointerException if the type specified for the property is invalid
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
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
Return the DynaClass
instance that describes the set
of properties available for this DynaBean
.
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
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}
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
Throws: IllegalArgumentException if there is no property of the specified name NullPointerException if the type specified for the property is invalid ClassCastException if the property is not a String.
Since: Struts 1.2
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
Throws: IllegalArgumentException if there is no property of the specified name NullPointerException if the type specified for the property is invalid ClassCastException if the property is not a String[].
Since: Struts 1.2
Initialize all bean properties to their initial values, as specified
in the {@link FormPropertyConfig} elements associated with the
definition of this DynaActionForm
.
Parameters: mapping The mapping used to select this instance
Indicates if an object of the source class is assignable to the destination class.
Parameters: dest Destination class source Source class
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
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 request The servlet request we are processing
Reset bean properties to their default state, as needed. This method is called before the properties are repopulated by the controller.
The default implementation (since Struts 1.1) does nothing.
Subclasses may override this method to reset bean properties to
default values, or the initialize
method may be used to
initialize property values to those provided in the form property
configuration information (which was the behavior of
this method in some release candidates).
Parameters: mapping The mapping used to select this instance request The servlet request we are processing
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 the type specified for the property is invalid NullPointerException if an attempt is made to set a primitive property to null
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 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
Set the DynaActionFormClass
instance with which we are
associated.
Parameters: dynaClass The DynaActionFormClass instance for this bean
Render a String representation of this object.