xdoclet.modules.apache.struts.ejb
public class StrutsFormSubTask extends AbstractEjbCodeGeneratorSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
Modifier and Type | Field and Description |
---|---|
protected xjavadoc.XTag |
currentFormTag
Form tag being processed right now.
|
protected static java.lang.String |
DEFAULT_TEMPLATE_FILE
The default template file - struts_form.xdt.
|
protected java.lang.String |
formClassPattern
The pattern for the form class.
|
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
StrutsFormSubTask()
Describe what the StrutsFormSubTask constructor does
|
Modifier and Type | Method and Description |
---|---|
protected void |
engineStarted()
Describe what the method does
|
protected void |
generateForClass(xjavadoc.XClass clazz)
iterate through all struts:form tags,and produce separate classes
|
xjavadoc.XTag |
getCurrentFormTag()
Gets the CurrentFormTag attribute of the StrutsFormSubTask object
|
protected java.lang.String |
getGeneratedFileName(xjavadoc.XClass clazz)
Gets the GeneratedFileName attribute of the StrutsFormSubTask object
|
java.lang.String |
getStrutsFormClassPattern()
Return the class pattern.
|
protected boolean |
matchesGenerationRules(xjavadoc.XClass clazz)
Returns whether struts form[s] shall be generated for this class
|
void |
setCurrentFormTag(xjavadoc.XTag t)
Sets the CurrentFormTag attribute of the StrutsFormSubTask object
|
void |
setPattern(java.lang.String newPattern)
Sets the Pattern attribute of the StrutsFormSubTask object
|
void |
validateOptions()
Called to validate configuration parameters.
|
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, execute, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, processInnerClasses, setAcceptAbstractClasses, setAcceptInterfaces, setDestinationFile, setEngine, setExtent, setExtentValue, setGenerationManager, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess, startProcessForAll, startProcessPerClass
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName
getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
protected static final java.lang.String DEFAULT_TEMPLATE_FILE
protected java.lang.String formClassPattern
protected xjavadoc.XTag currentFormTag
public StrutsFormSubTask()
public xjavadoc.XTag getCurrentFormTag()
public java.lang.String getStrutsFormClassPattern()
public void setCurrentFormTag(xjavadoc.XTag t)
t
- The new CurrentFormTag valuepublic void setPattern(java.lang.String newPattern)
newPattern
- The new Pattern valuepublic void validateOptions() throws XDocletException
validateOptions
in class TemplateSubTask
XDocletException
- Description of Exceptionprotected java.lang.String getGeneratedFileName(xjavadoc.XClass clazz) throws XDocletException
getGeneratedFileName
in class TemplateSubTask
clazz
- Describe what the parameter doesXDocletException
- Describe the exceptionprotected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
matchesGenerationRules
in class TemplateSubTask
clazz
- Description of ParameterXDocletException
- Description of Exceptionprotected void generateForClass(xjavadoc.XClass clazz) throws XDocletException
generateForClass
in class TemplateSubTask
clazz
- Description of ParameterXDocletException
- Description of Exceptionprotected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
- Describe the exception