xdoclet.modules.doc.info
public class InfoSubTask extends TemplateSubTask
TemplateSubTask.ExtentTypes, TemplateSubTask.OfType
currentClassTag, currentFieldTag, currentMethodTag
Constructor and Description |
---|
InfoSubTask() |
Modifier and Type | Method and Description |
---|---|
protected void |
engineStarted()
Describe what the method does
|
void |
execute()
Describe what the method does
|
java.lang.String |
getHeader()
Gets the Header attribute of the InfoSubTask object
|
java.lang.String |
getProjectname()
Gets the Projectname attribute of the InfoSubTask object
|
protected java.util.Properties |
getProperties()
Gets the Properties attribute of the InfoSubTask object
|
void |
setHeader(java.lang.String header)
Sets the Header attribute of the InfoSubTask object
|
void |
setProjectname(java.lang.String projectname)
Sets the Projectname attribute of the InfoSubTask object
|
void |
setTag(java.lang.String tag)
Sets the Tag attribute of the InfoSubTask object
|
void |
validateOptions()
validate options - noop here
|
addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, 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
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
public java.lang.String getHeader()
public java.lang.String getProjectname()
public void setHeader(java.lang.String header)
header
- The new Header valuepublic void setTag(java.lang.String tag)
tag
- The new Tag valuepublic void setProjectname(java.lang.String projectname)
projectname
- The new Projectname valuepublic void execute() throws XDocletException
TemplateSubTask
execute
in class TemplateSubTask
XDocletException
- Description of Exceptionpublic void validateOptions() throws XDocletException
validateOptions
in class TemplateSubTask
XDocletException
protected java.util.Properties getProperties()
protected void engineStarted() throws XDocletException
engineStarted
in class TemplateSubTask
XDocletException
- Describe the exception