xdoclet

Class TemplateSubTask

Implemented Interfaces:
Serializable

public class TemplateSubTask
extends xdoclet.SubTask

Nested Class Summary

static class
TemplateSubTask.ExtentTypes
static class
TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

TemplateSubTask()

Method Summary

protected void
addOfType(String ofType)
void
addOfType(TemplateSubTask.OfType ofType)
void
addPackageSubstitution(PackageTagsHandler.PackageSubstitution ps)
void
copyAttributesFrom(xdoclet.TemplateSubTask src)
protected void
engineFinished()
protected void
engineStarted()
void
execute()
protected void
generateForClass(XClass clazz)
boolean
getAcceptAbstractClasses()
boolean
getAcceptInterfaces()
String
getDestinationFile()
xdoclet.template.TemplateEngine
getEngine()
String
getExtent()
protected String
getGeneratedFileName(XClass clazz)
xdoclet.GenerationManager
getGenerationManager()
String
getHavingClassTag()
String[]
getOfType()
ArrayList
getPackageSubstitutions()
String
getSubTaskClassName()
URL
getTemplateURL()
void
init(XJavaDoc xJavaDoc)
boolean
isPackageSubstitutionInheritanceSupported()
boolean
isPrefixWithPackageStructure()
protected static String
javaFile(String className)
protected boolean
matchesGenerationRules(XClass clazz)
protected boolean
processInnerClasses()
void
setAcceptAbstractClasses(boolean acceptAbstractClasses)
void
setAcceptInterfaces(boolean acceptInterfaces)
void
setDestinationFile(String destinationFile)
void
setEngine(xdoclet.template.TemplateEngine engine)
void
setExtent(TemplateSubTask.ExtentTypes extent)
protected void
setExtentValue(String extent)
protected void
setGenerationManager(GenerationManager gM)
void
setHavingClassTag(String havingClassTag)
void
setOfType(String ofType)
void
setPackageSubstitutionInheritanceSupported(boolean packageSubstitutionInheritanceSupported)
void
setPackageSubstitutions(ArrayList packageSubstitutions)
void
setPrefixWithPackageStructure(boolean prefixWithPackageStructure)
void
setSubTaskClassName(String subTaskClassName)
void
setTemplateFile(File templateFile)
void
setTemplateURL(URL templateURL)
protected void
startEngine(URL templateURL, File outputFile)
protected void
startProcess()
protected void
startProcessForAll()
protected void
startProcessPerClass()
void
validateOptions()

Methods inherited from class xdoclet.SubTask

addConfigParam, copyAttributesFrom, execute, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, init, setDestDir, setMergeDir, setSubTaskName, validateOptions

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage

Constructor Details

TemplateSubTask

public TemplateSubTask()

Method Details

addOfType

protected void addOfType(String ofType)

addOfType

public void addOfType(TemplateSubTask.OfType ofType)

addPackageSubstitution

public void addPackageSubstitution(PackageTagsHandler.PackageSubstitution ps)

copyAttributesFrom

public void copyAttributesFrom(xdoclet.TemplateSubTask src)
Overrides:
copyAttributesFrom in interface xdoclet.SubTask

engineFinished

protected void engineFinished()
            throws xdoclet.template.TemplateException

engineStarted

protected void engineStarted()
            throws xdoclet.XDocletException

execute

public void execute()
            throws xdoclet.XDocletException
Overrides:
execute in interface xdoclet.SubTask

generateForClass

protected void generateForClass(XClass clazz)
            throws xdoclet.XDocletException

getAcceptAbstractClasses

public boolean getAcceptAbstractClasses()

getAcceptInterfaces

public boolean getAcceptInterfaces()

getDestinationFile

public String getDestinationFile()

getEngine

public xdoclet.template.TemplateEngine getEngine()

getExtent

public String getExtent()

getGeneratedFileName

protected String getGeneratedFileName(XClass clazz)
            throws xdoclet.XDocletException

getGenerationManager

public xdoclet.GenerationManager getGenerationManager()

getHavingClassTag

public String getHavingClassTag()

getOfType

public String[] getOfType()

getPackageSubstitutions

public ArrayList getPackageSubstitutions()

getSubTaskClassName

public String getSubTaskClassName()

getTemplateURL

public URL getTemplateURL()

init

public void init(XJavaDoc xJavaDoc)
            throws xdoclet.XDocletException
Overrides:
init in interface xdoclet.SubTask

isPackageSubstitutionInheritanceSupported

public boolean isPackageSubstitutionInheritanceSupported()

isPrefixWithPackageStructure

public boolean isPrefixWithPackageStructure()

javaFile

protected static String javaFile(String className)

matchesGenerationRules

protected boolean matchesGenerationRules(XClass clazz)
            throws xdoclet.XDocletException

processInnerClasses

protected boolean processInnerClasses()

setAcceptAbstractClasses

public void setAcceptAbstractClasses(boolean acceptAbstractClasses)

setAcceptInterfaces

public void setAcceptInterfaces(boolean acceptInterfaces)

setDestinationFile

public void setDestinationFile(String destinationFile)

setEngine

public void setEngine(xdoclet.template.TemplateEngine engine)

setExtent

public void setExtent(TemplateSubTask.ExtentTypes extent)

setExtentValue

protected void setExtentValue(String extent)

setGenerationManager

protected void setGenerationManager(GenerationManager gM)

setHavingClassTag

public void setHavingClassTag(String havingClassTag)

setOfType

public void setOfType(String ofType)

setPackageSubstitutionInheritanceSupported

public void setPackageSubstitutionInheritanceSupported(boolean packageSubstitutionInheritanceSupported)

setPackageSubstitutions

public void setPackageSubstitutions(ArrayList packageSubstitutions)

setPrefixWithPackageStructure

public void setPrefixWithPackageStructure(boolean prefixWithPackageStructure)

setSubTaskClassName

public void setSubTaskClassName(String subTaskClassName)

setTemplateFile

public void setTemplateFile(File templateFile)
            throws xdoclet.XDocletException

setTemplateURL

public void setTemplateURL(URL templateURL)

startEngine

protected final void startEngine(URL templateURL,
                                 File outputFile)
            throws xdoclet.template.TemplateException

startProcess

protected void startProcess()
            throws xdoclet.XDocletException

startProcessForAll

protected void startProcessForAll()
            throws xdoclet.XDocletException

startProcessPerClass

protected void startProcessPerClass()
            throws xdoclet.XDocletException

validateOptions

public void validateOptions()
            throws xdoclet.XDocletException
Overrides:
validateOptions in interface xdoclet.SubTask