|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.DocletSupport
xdoclet.SubTask
xdoclet.TemplateSubTask
xdoclet.modules.ejb.AbstractEjbCodeGeneratorSubTask
xdoclet.modules.apache.struts.ejb.StrutsFormSubTask
public class StrutsFormSubTask
Generates a Struts ActionForm, based on an entity EJB. More information on Struts is available on the Struts website , or the ActionForm API .
Nested Class Summary |
---|
Nested classes/interfaces inherited from class xdoclet.TemplateSubTask |
---|
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType |
Field Summary | |
---|---|
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. |
Fields inherited from class xdoclet.DocletSupport |
---|
currentClassTag, currentFieldTag, currentMethodTag |
Constructor Summary | |
---|---|
StrutsFormSubTask()
Describe what the StrutsFormSubTask constructor does |
Method Summary | |
---|---|
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. |
Methods inherited from class xdoclet.SubTask |
---|
addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.String DEFAULT_TEMPLATE_FILE
protected java.lang.String formClassPattern
protected xjavadoc.XTag currentFormTag
Constructor Detail |
---|
public StrutsFormSubTask()
Method Detail |
---|
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 does
XDocletException
- Describe the exceptionprotected boolean matchesGenerationRules(xjavadoc.XClass clazz) throws XDocletException
matchesGenerationRules
in class TemplateSubTask
clazz
- Description of Parameter
XDocletException
- Description of Exceptionprotected void generateForClass(xjavadoc.XClass clazz) throws XDocletException
generateForClass
in class TemplateSubTask
clazz
- Description of Parameter
XDocletException
- Description of Exceptionprotected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
- Describe the exception
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |