net.sf.xsnapshot.ant
Class XSnapshotCreateHelperSubTask

java.lang.Object
  xdoclet.DocletSupport
      xdoclet.SubTask
          xdoclet.TemplateSubTask
              net.sf.xsnapshot.ant.XSnapshotSubTask
                  net.sf.xsnapshot.ant.XSnapshotCreateHelperSubTask

All Implemented Interfaces:

Serializable

public class XSnapshotCreateHelperSubTask

extends XSnapshotSubTask

Subtask to create helper classes. * This subtask should be included within the main XSnapshot Doclet Task * * @author Bill Schneider * * @ant.element name="helper" display-name="XSnapshot Helpers" parent="net.sf.xsnapshot.ant.XSnapshotDocletTask"

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class xdoclet.TemplateSubTask

xdoclet.TemplateSubTask.ExtentTypes, xdoclet.TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

XSnapshotCreateHelperSubTask()

Method Summary

protected void	engineStarted() Called when the engine is started
protected String	getGeneratedFileName(xjavadoc.XClass clazz)
protected String	getTemplate()
protected boolean	skipSnapshot(xjavadoc.XTag tag) Indicates whether this snapshot should be skipped.

Methods inherited from class net.sf.xsnapshot.ant.XSnapshotSubTask

generateForClass, getCurrentSnapshotClass, getCurrentSnapshotName

Methods inherited from class xdoclet.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, execute, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, 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, validateOptions

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getConfigParamsAsMap, getContext, getDestDir, getMergeDir, getSubTaskName, getXJavaDoc, setDestDir, setMergeDir, setSubTaskName

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XSnapshotCreateHelperSubTask

public XSnapshotCreateHelperSubTask()

Method Detail

getTemplate

protected String getTemplate()

Specified by:

getTemplate in class XSnapshotSubTask

skipSnapshot

protected boolean skipSnapshot(xjavadoc.XTag tag)

Indicates whether this snapshot should be skipped. True if the * xdoclet tag for this snapshot has generate-helper attribute set * to 'false'. * @param tag the xdoclet tag * @return true if the tag has generate-helper="false"

Overrides:

skipSnapshot in class XSnapshotSubTask

Parameters:

tag - the Javadoc tag

Returns:

always false; subclasses may override to return true if the snapshot described by this tag should be skipped

getGeneratedFileName

protected String getGeneratedFileName(xjavadoc.XClass clazz)
                               throws xdoclet.XDocletException

Throws:

xdoclet.XDocletException

engineStarted

protected void engineStarted()

Called when the engine is started