xdoclet.modules.apache.struts
Class ActionFormSubTask
java.lang.Objectxdoclet.DocletSupportxdoclet.SubTaskxdoclet.TemplateSubTaskxdoclet.modules.apache.struts.ActionFormSubTask
- Serializable
public class ActionFormSubTask
extends xdoclet.TemplateSubTask
- Matt Raible (matt@raibledesigns.com)
- display-name = "Action Form"
name = "actionform"
parent = "xdoclet.DocletTask"
protected void | engineStarted()- Describe what the method does
|
protected void | generateForClass(XClass clazz)- iterate through all struts:form tags,and produce separate classes
|
String | getActionFormClassPattern()- Return the class pattern.
|
XTag | getCurrentFormTag()- Gets the CurrentFormTag attribute of the ActionFormSubTask object
|
protected String | getGeneratedFileName(XClass clazz)- Gets the GeneratedFileName attribute of the ActionFormSubTask object
|
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 ActionFormSubTask object
|
void | setPattern(String newPattern)- Sets the Pattern attribute of the ActionFormSubTask object
|
void | validateOptions()- Called to validate configuration parameters.
|
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGeneratedFileName, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, matchesGenerationRules, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass, validateOptions |
addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions |
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage |
DEFAULT_TEMPLATE_FILE
protected static 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.
ActionFormSubTask
public ActionFormSubTask()
Describe what the ActionFormActionFormSubTaskstructor does
engineStarted
protected void engineStarted()
throws xdoclet.XDocletException Describe what the method does
- engineStarted in interface xdoclet.TemplateSubTask
xdoclet.XDocletException - Describe the exception
generateForClass
protected void generateForClass(XClass clazz)
throws xdoclet.XDocletException iterate through all struts:form tags,and produce separate classes
- generateForClass in interface xdoclet.TemplateSubTask
clazz - Description of Parameter
xdoclet.XDocletException - Description of Exception
getActionFormClassPattern
public String getActionFormClassPattern()
Return the class pattern.
- The ActionFormClassPattern value
getCurrentFormTag
public XTag getCurrentFormTag()
Gets the CurrentFormTag attribute of the ActionFormSubTask object
getGeneratedFileName
protected String getGeneratedFileName(XClass clazz)
throws xdoclet.XDocletException Gets the GeneratedFileName attribute of the ActionFormSubTask object
- getGeneratedFileName in interface xdoclet.TemplateSubTask
clazz - Describe what the parameter does
- The GeneratedFileName value
xdoclet.XDocletException - Describe the exception
matchesGenerationRules
protected boolean matchesGenerationRules(XClass clazz)
throws xdoclet.XDocletException Returns whether struts form[s] shall be generated for this class
- matchesGenerationRules in interface xdoclet.TemplateSubTask
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 ActionFormSubTask object
t - The new CurrentFormTag value
setPattern
public void setPattern(String newPattern)
Sets the Pattern attribute of the ActionFormSubTask object
newPattern - The new Pattern value
validateOptions
public void validateOptions()
throws xdoclet.XDocletException Called to validate configuration parameters.
- validateOptions in interface xdoclet.TemplateSubTask
xdoclet.XDocletException - Description of Exception