net.sf.xsnapshot.ant
Class XSnapshotCreateSnapshotSubTask

java.lang.Object
  extended byxdoclet.DocletSupport
      extended byxdoclet.SubTask
          extended byxdoclet.TemplateSubTask
              extended bynet.sf.xsnapshot.ant.XSnapshotSubTask
                  extended bynet.sf.xsnapshot.ant.XSnapshotCreateSnapshotSubTask
All Implemented Interfaces:
Serializable

public class XSnapshotCreateSnapshotSubTask
extends XSnapshotSubTask

Subtask to create snapshot classes. This subtask should be included within the main XSnapshot Doclet Task * * @author Bill Schneider * @ant.element name="snapshot" display-name="XSnapshot Snapshots" parent="net.sf.xsnapshot.ant.XSnapshotDocletTask" * @xdoclet.merge-file file="snapshot-{0}.xdt" relates-to="{0}.java" description="Allows you to place additional code inside all snapshot classes generated from a model class" * @xdoclet.merge-file file="snapshot-[snapshot-name]-{0}.xdt" relates-to="{0}.java" description="Allows you to place additional code inside the snapshot class with the given name generated from a model class"

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
XSnapshotCreateSnapshotSubTask()
           
 
Method Summary
protected  void engineStarted()
          Called when the engine is started
protected  String getGeneratedFileName(xjavadoc.XClass clazz)
           
protected  String getTemplate()
           
 
Methods inherited from class net.sf.xsnapshot.ant.XSnapshotSubTask
generateForClass, getCurrentSnapshotClass, getCurrentSnapshotName, skipSnapshot
 
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

XSnapshotCreateSnapshotSubTask

public XSnapshotCreateSnapshotSubTask()
Method Detail

getGeneratedFileName

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

getTemplate

protected String getTemplate()
Specified by:
getTemplate in class XSnapshotSubTask

engineStarted

protected void engineStarted()
Called when the engine is started