xdoclet.ejb.vendor
Class StrutsFormSubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask
              |
              +--xdoclet.TemplateSubTask
                    |
                    +--xdoclet.ejb.AbstractEjbCodeGeneratorSubTask
                          |
                          +--xdoclet.ejb.vendor.StrutsFormSubTask

All Implemented Interfaces:

java.io.Serializable

public class StrutsFormSubTask

extends AbstractEjbCodeGeneratorSubTask

Creates a Struts ActionForm based on an entity EJB.

Version:

$Revision: 1.11 $

Author:

Dmitri Colebatch (dim@bigpond.net.au)

See Also:

Serialized Form

Inner classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes

Field Summary

protected com.sun.javadoc.Tag	currentFormTag Form tag being processed right now
protected static java.lang.String	DEFAULT_TEMPLATE_FILE The default template file - struts_form.j.
protected java.lang.String	formClassPattern The pattern for the form class.
static java.lang.String	SUBTASK_NAME

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

StrutsFormSubTask()

Method Summary

protected void	engineStarted()
protected void	generateForClass(com.sun.javadoc.ClassDoc clazz) iterate through all
com.sun.javadoc.Tag	getCurrentFormTag()
protected java.lang.String	getGeneratedFileName(com.sun.javadoc.ClassDoc clazz) Returns class name for the generated file.
java.lang.String	getStrutsFormClassPattern() Return the class pattern.
java.lang.String	getSubTaskName()
protected boolean	matchesGenerationRules(com.sun.javadoc.ClassDoc clazz) Returns whether struts form[s] shall be generated for this class
void	setCurrentFormTag(com.sun.javadoc.Tag t)
void	setPattern(java.lang.String new_pattern)
void	validateOptions() Called to validate configuration parameters.

Methods inherited from class xdoclet.TemplateSubTask

addPackageSubstitution, beanFile, copyAttributesFrom, engineFinished, execute, getDestinationFile, getEngine, getExtent, getHavingClassTag, getOfType, getPackageSubstitutions, getParser, getSubTaskClassName, getTemplateURL, init, isGuessGenerationNeeded, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, setDestinationFile, setEngine, setExtent, setExtentValue, setGuessGenerationNeeded, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setParser, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getContext, getDestDir, getMergeDir, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBTASK_NAME

public static final java.lang.String SUBTASK_NAME

DEFAULT_TEMPLATE_FILE

protected static java.lang.String DEFAULT_TEMPLATE_FILE

The default template file - struts_form.j.

formClassPattern

protected java.lang.String formClassPattern

The pattern for the form class. Defaults to {0}{1}Form if not present.

currentFormTag

protected com.sun.javadoc.Tag currentFormTag

Form tag being processed right now

Constructor Detail

StrutsFormSubTask

public StrutsFormSubTask()

Method Detail

getCurrentFormTag

public com.sun.javadoc.Tag getCurrentFormTag()

getSubTaskName

public java.lang.String getSubTaskName()

Overrides:

getSubTaskName in class TemplateSubTask

getStrutsFormClassPattern

public java.lang.String getStrutsFormClassPattern()

Return the class pattern.

Returns:

The StrutsFormClassPattern value

setCurrentFormTag

public void setCurrentFormTag(com.sun.javadoc.Tag t)

setPattern

public void setPattern(java.lang.String new_pattern)

validateOptions

public void validateOptions()
                     throws XDocletException

Called to validate configuration parameters.

Overrides:

validateOptions in class TemplateSubTask

Throws:

XDocletException - Description of Exception

getGeneratedFileName

protected java.lang.String getGeneratedFileName(com.sun.javadoc.ClassDoc clazz)
                                         throws XDocletException

Description copied from class: TemplateSubTask

Returns class name for the generated file. {0} substituted by class name.

Overrides:

getGeneratedFileName in class TemplateSubTask

Following copied from class: xdoclet.TemplateSubTask

Parameters:

clazz - Description of Parameter

Returns:

The GeneratedClassName value

Throws:

XDocletException - Description of Exception

matchesGenerationRules

protected boolean matchesGenerationRules(com.sun.javadoc.ClassDoc clazz)
                                  throws XDocletException

Returns whether struts form[s] shall be generated for this class

Overrides:

matchesGenerationRules in class TemplateSubTask

Parameters:

clazz - Description of Parameter

Returns:

is form tag shall be generated

Throws:

XDocletException - Description of Exception

generateForClass

protected void generateForClass(com.sun.javadoc.ClassDoc clazz)
                         throws XDocletException

iterate through all

Overrides:

generateForClass in class TemplateSubTask

Parameters:

clazz - Description of Parameter

Throws:

XDocletException - Description of Exception

engineStarted

protected void engineStarted()
                      throws XDocletException

Overrides:

engineStarted in class TemplateSubTask