|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.struts.action.ActionForm | +--org.apache.struts.action.DynaActionForm
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.
Field Summary | |
protected DynaActionFormClass |
dynaClass
The DynaActionFormClass with which we are associated. |
protected java.util.HashMap |
dynaValues
The set of property values for this DynaActionForm ,
keyed by property name. |
Fields inherited from class org.apache.struts.action.ActionForm |
multipartRequestHandler, servlet |
Constructor Summary | |
DynaActionForm()
|
Method Summary | |
boolean |
contains(java.lang.String name,
java.lang.String key)
Indicates if the specified mapped property contain a value for the specified key value. |
java.lang.Object |
get(java.lang.String name)
Return the value of a simple property with the specified name. |
java.lang.Object |
get(java.lang.String name,
int index)
Return the value of an indexed property with the specified name. |
java.lang.Object |
get(java.lang.String name,
java.lang.String key)
Return the value of a mapped property with the specified name, or null if there is no value for the specified key. |
org.apache.commons.beanutils.DynaClass |
getDynaClass()
Return the DynaClass instance that describes the set
of properties available for this DynaBean . |
protected org.apache.commons.beanutils.DynaProperty |
getDynaProperty(java.lang.String name)
Return the property descriptor for the specified property name. |
java.util.Map |
getMap()
Returns the Map containing the property values. |
java.lang.String |
getString(java.lang.String name)
Return the value of a String property with the specified
name. |
java.lang.String[] |
getStrings(java.lang.String name)
Return the value of a String[] property with the
specified name. |
void |
initialize(ActionMapping mapping)
Initialize all bean properties to their initial values, as specified in the FormPropertyConfig elements associated with the
definition of this DynaActionForm . |
void |
initialize(FormBeanConfig config)
|
protected boolean |
isDynaAssignable(java.lang.Class dest,
java.lang.Class source)
Indicates if an object of the source class is assignable to the destination class. |
void |
remove(java.lang.String name,
java.lang.String key)
Remove any existing value for the specified key on the specified mapped property. |
void |
reset(ActionMapping mapping,
javax.servlet.http.HttpServletRequest request)
Reset bean properties to their default state, as needed. |
void |
reset(ActionMapping mapping,
javax.servlet.ServletRequest request)
Reset bean properties to their default state, as needed. |
void |
set(java.lang.String name,
int index,
java.lang.Object value)
Set the value of an indexed property with the specified name. |
void |
set(java.lang.String name,
java.lang.Object value)
Set the value of a simple property with the specified name. |
void |
set(java.lang.String name,
java.lang.String key,
java.lang.Object value)
Set the value of a mapped property with the specified name. |
(package private) void |
setDynaActionFormClass(DynaActionFormClass dynaClass)
Set the DynaActionFormClass instance with which we are
associated. |
java.lang.String |
toString()
Render a String representation of this object. |
Methods inherited from class org.apache.struts.action.ActionForm |
getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate, validate |
Methods inherited from class java.lang.Object |
|
Field Detail |
protected DynaActionFormClass dynaClass
The DynaActionFormClass
with which we are associated.
protected java.util.HashMap dynaValues
The set of property values for this DynaActionForm
,
keyed by property name.
Constructor Detail |
public DynaActionForm()
Method Detail |
public void initialize(ActionMapping mapping)
Initialize all bean properties to their initial values, as specified
in the FormPropertyConfig
elements associated with the
definition of this DynaActionForm
.
mapping
- The mapping used to select this instancepublic void initialize(FormBeanConfig config)
public void reset(ActionMapping mapping, javax.servlet.ServletRequest request)
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.
reset
in class ActionForm
mapping
- The mapping used to select this instancerequest
- The servlet request we are processingpublic void reset(ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
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).
reset
in class ActionForm
mapping
- The mapping used to select this instancerequest
- The servlet request we are processingpublic boolean contains(java.lang.String name, java.lang.String key)
Indicates if the specified mapped property contain a value for the specified key value.
contains
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property to checkkey
- Name of the key to checkjava.lang.IllegalArgumentException
- if there is no property
of the specified namepublic java.lang.Object get(java.lang.String name)
Return the value of a simple property with the specified name.
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified nameNullPointerException
- if the type specified for the
property is invalidpublic java.lang.Object get(java.lang.String name, int index)
Return the value of an indexed property with the specified name.
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not indexedjava.lang.IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying propertyNullPointerException
- if no array or List has been
initialized for this propertypublic java.lang.Object get(java.lang.String name, java.lang.String key)
Return the value of a mapped property with the specified name,
or null
if there is no value for the specified key.
get
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be retrievedkey
- Key of the value to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not mappedpublic java.lang.String getString(java.lang.String name)
Return the value of a String
property with the specified
name. This is equivalent to calling
(String) dynaForm.get(name)
.
name
- Name of the property whose value is to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified nameNullPointerException
- if the type specified for the
property is invalidClassCastException
- if the property is not a String.public java.lang.String[] getStrings(java.lang.String name)
Return the value of a String[]
property with the
specified name. This is equivalent to calling
(String[]) dynaForm.get(name)
.
name
- Name of the property whose value is to be retrievedjava.lang.IllegalArgumentException
- if there is no property
of the specified nameNullPointerException
- if the type specified for the
property is invalidClassCastException
- if the property is not a String[].public org.apache.commons.beanutils.DynaClass getDynaClass()
Return the DynaClass
instance that describes the set
of properties available for this DynaBean
.
getDynaClass
in interface org.apache.commons.beanutils.DynaBean
public java.util.Map getMap()
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}
public void remove(java.lang.String name, java.lang.String key)
Remove any existing value for the specified key on the specified mapped property.
remove
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property for which a value is to
be removedkey
- Key of the value to be removedjava.lang.IllegalArgumentException
- if there is no property
of the specified namepublic void set(java.lang.String name, java.lang.Object value)
Set the value of a simple property with the specified name.
set
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be setorg.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified nameNullPointerException
- if the type specified for the
property is invalidNullPointerException
- if an attempt is made to set a
primitive property to nullpublic void set(java.lang.String name, int index, java.lang.Object value)
Set the value of an indexed property with the specified name.
set
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be setindex
- Index of the property to be setvalue
- Value to which this property is to be setorg.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not indexedjava.lang.IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying propertypublic void set(java.lang.String name, java.lang.String key, java.lang.Object value)
Set the value of a mapped property with the specified name.
set
in interface org.apache.commons.beanutils.DynaBean
name
- Name of the property whose value is to be setkey
- Key of the property to be setvalue
- Value to which this property is to be setorg.apache.commons.beanutils.ConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not mappedpublic java.lang.String toString()
Render a String representation of this object.
toString
in class java.lang.Object
void setDynaActionFormClass(DynaActionFormClass dynaClass)
Set the DynaActionFormClass
instance with which we are
associated.
dynaClass
- The DynaActionFormClass instance for this beanprotected org.apache.commons.beanutils.DynaProperty getDynaProperty(java.lang.String name)
Return the property descriptor for the specified property name.
name
- Name of the property for which to retrieve the descriptorjava.lang.IllegalArgumentException
- if this is not a valid property
name for our DynaClassprotected boolean isDynaAssignable(java.lang.Class dest, java.lang.Class source)
Indicates if an object of the source class is assignable to the destination class.
dest
- Destination classsource
- Source class
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |