|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.struts.action.ActionForm
org.apache.struts.action.DynaActionForm
public class 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)
Initialize the specified form bean. |
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 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. |
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. |
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 |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| 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)
Initialize the specified form bean.
config - The configuration for the form bean to initialize.
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 ActionFormmapping - The mapping used to select this instancerequest - The servlet request we are processing
public void reset(ActionMapping mapping,
javax.servlet.http.HttpServletRequest request)
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.
reset in class ActionFormmapping - The mapping used to select this instancerequest - The servlet request we are processing
public 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.DynaBeanname - Name of the property to checkkey - Name of the key to check
true if the specified mapped property contains a
value for the specified key value; true
otherwise.
java.lang.NullPointerException - if there is no property of the
specified name
java.lang.IllegalArgumentException - if there is no mapped 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.DynaBeanname - Name of the property whose value is to be retrieved
java.lang.IllegalArgumentException - if there is no property of the
specified name
java.lang.NullPointerException - if the type specified for the property
is invalid
public 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.DynaBeanname - Name of the property whose value is to be retrievedindex - Index of the value to be retrieved
java.lang.IllegalArgumentException - if there is no property of the
specified name
java.lang.IllegalArgumentException - if the specified property exists, but
is not indexed
java.lang.NullPointerException - if no array or List has been
initialized for this property
public 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.DynaBeanname - Name of the property whose value is to be retrievedkey - Key of the value to be retrieved
null if there is no value for the specified key.
java.lang.NullPointerException - if there is no property of the
specified name
java.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 retrieved.
String property with the specified
name.
java.lang.IllegalArgumentException - if there is no property of the
specified name
java.lang.NullPointerException - if the type specified for the property
is invalid
java.lang.ClassCastException - 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 retrieved.
String[] property with the
specified name.
java.lang.IllegalArgumentException - if there is no property of the
specified name
java.lang.NullPointerException - if the type specified for the property
is invalid
java.lang.ClassCastException - 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.DynaBeanDynaClass instance that describes the set of
properties available for this 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}
Map containing the property values.
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.DynaBeanname - Name of the property for which a value is to be removedkey - Key of the value to be removed
java.lang.NullPointerException - if there is no property of the
specified name
java.lang.IllegalArgumentException - if there is no mapped property of the
specified name
public 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.DynaBeanname - Name of the property whose value is to be setvalue - Value to which this property is to be set
org.apache.commons.beanutils.ConversionException - if the specified value cannot be
converted to the type required for
this property
java.lang.IllegalArgumentException - if there is no property of the
specified name
java.lang.NullPointerException - if the type specified for the property
is invalid
java.lang.NullPointerException - if an attempt is made to set a
primitive property to null
public 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.DynaBeanname - 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 set
org.apache.commons.beanutils.ConversionException - if the specified value cannot be
converted to the type required for
this property
java.lang.NullPointerException - if there is no property of the
specified name
java.lang.IllegalArgumentException - if the specified property exists, but
is not indexed
java.lang.IndexOutOfBoundsException - if the specified index is outside the
range of the underlying property
public 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.DynaBeanname - 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 set
java.lang.NullPointerException - if there is no property of the
specified name
java.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.Objectprotected 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 descriptor
java.lang.IllegalArgumentException - if this is not a valid property name
for our DynaClass
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.
dest - Destination classsource - Source class
true if the source is assignable to the
destination; false otherwise.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||