xdoclet.modules.apache.struts.ejb
Class StrutsFormSubTask
AbstractEjbCodeGeneratorSubTask
xdoclet.modules.apache.struts.ejb.StrutsFormSubTask
public class StrutsFormSubTask
extends AbstractEjbCodeGeneratorSubTask
Generates a Struts ActionForm, based on an entity EJB. More information on Struts is available on the
Struts website , or the
ActionForm API .
- Dmitri Colebatch (dim@bigpond.net.au)
- display-name = "Struts Form"
name = "strutsform"
parent = "xdoclet.modules.ejb.EjbDocletTask"
protected void | engineStarted() - Describe what the method does
|
protected void | generateForClass(XClass clazz) - iterate through all struts:form tags,and produce separate classes
|
XTag | getCurrentFormTag() - Gets the CurrentFormTag attribute of the StrutsFormSubTask object
|
protected String | getGeneratedFileName(XClass clazz) - Gets the GeneratedFileName attribute of the StrutsFormSubTask object
|
String | getStrutsFormClassPattern() - Return the class pattern.
|
protected boolean | matchesGenerationRules(XClass clazz) - Returns whether struts form[s] shall be generated for this class
|
void | setCurrentFormTag(XTag t) - Sets the CurrentFormTag attribute of the StrutsFormSubTask object
|
void | setPattern(String newPattern) - Sets the Pattern attribute of the StrutsFormSubTask object
|
void | validateOptions() - Called to validate configuration parameters.
|
DEFAULT_TEMPLATE_FILE
protected static final String DEFAULT_TEMPLATE_FILE
The default template file - struts_form.xdt.
currentFormTag
protected XTag currentFormTag
Form tag being processed right now.
formClassPattern
protected String formClassPattern
The pattern for the form class. Defaults to {0}{1}Form if not present.
StrutsFormSubTask
public StrutsFormSubTask()
Describe what the StrutsFormSubTask constructor does
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException
Describe what the method does
xdoclet.XDocletException
- Describe the exception
generateForClass
protected void generateForClass(XClass clazz)
throws xdoclet.XDocletException
iterate through all struts:form tags,and produce separate classes
clazz
- Description of Parameter
xdoclet.XDocletException
- Description of Exception
getCurrentFormTag
public XTag getCurrentFormTag()
Gets the CurrentFormTag attribute of the StrutsFormSubTask object
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException
Gets the GeneratedFileName attribute of the StrutsFormSubTask object
clazz
- Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException
- Describe the exception
getStrutsFormClassPattern
public String getStrutsFormClassPattern()
Return the class pattern.
- The StrutsFormClassPattern value
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException
Returns whether struts form[s] shall be generated for this class
clazz
- Description of Parameter
- is form tag shall be generated
xdoclet.XDocletException
- Description of Exception
setCurrentFormTag
public void setCurrentFormTag(XTag t)
Sets the CurrentFormTag attribute of the StrutsFormSubTask object
t
- The new CurrentFormTag value
setPattern
public void setPattern(String newPattern)
Sets the Pattern attribute of the StrutsFormSubTask object
newPattern
- The new Pattern value
validateOptions
public void validateOptions()
throws xdoclet.XDocletException
Called to validate configuration parameters.
xdoclet.XDocletException
- Description of Exception