xdoclet.modules.mockobjects
Class MockObjectSubTask

java.lang.Object
  xdoclet.DocletSupport
      xdoclet.SubTask
          xdoclet.TemplateSubTask
              xdoclet.modules.mockobjects.MockObjectSubTask

All Implemented Interfaces:

Serializable

public class MockObjectSubTask

extends TemplateSubTask

Subtask for mockobject.

Author:

Joe Walnes, Stig Jørgensen

See Also:

Serialized Form

ant.element

name="mockobjects" display-name="Mockmaker" parent="xdoclet.modules.mockobjects.MockObjectDocletTask"

created

5. februar 2003

Nested Class Summary

Nested classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes, TemplateSubTask.OfType

Field Summary

Fields inherited from class xdoclet.DocletSupport

currentClassTag, currentFieldTag, currentMethodTag

Constructor Summary

MockObjectSubTask()
Initialize the default behaviour.

Method Summary

protected String	getGeneratedFileName(xjavadoc.XClass clazz) Gets the GeneratedFileName attribute of the DaoSubTask object
String	getMockClassPattern() Returns the mockClassPattern.
protected boolean	matchesGenerationRules(xjavadoc.XClass clazz) Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise.
void	setMockClassPattern(String mockClassPattern) Sets the mockClassPattern.

Methods inherited from class xdoclet.TemplateSubTask

addOfType, addOfType, addPackageSubstitution, copyAttributesFrom, engineFinished, engineStarted, execute, generateForClass, getAcceptAbstractClasses, getAcceptInterfaces, getDestinationFile, getEngine, getExtent, getGenerationManager, getHavingClassTag, getOfType, getPackageSubstitutions, getSubTaskClassName, getTemplateURL, init, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, 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

MockObjectSubTask

public MockObjectSubTask()

Initialize the default behaviour.

Method Detail

getMockClassPattern

public String getMockClassPattern()

Returns the mockClassPattern.

Returns:

String the mockClassPattern.

setMockClassPattern

public void setMockClassPattern(String mockClassPattern)

Sets the mockClassPattern.

Parameters:

mockClassPattern - The mockClassPattern to set

getGeneratedFileName

protected String getGeneratedFileName(xjavadoc.XClass clazz)
                               throws XDocletException

Gets the GeneratedFileName attribute of the DaoSubTask object

Overrides:

getGeneratedFileName in class TemplateSubTask

Parameters:

clazz - Describe what the parameter does

Returns:

The GeneratedFileName value

Throws:

XDocletException

matchesGenerationRules

protected boolean matchesGenerationRules(xjavadoc.XClass clazz)
                                  throws XDocletException

Description copied from class: TemplateSubTask

Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise. If returned false, no output file is generated for clazz.

Overrides:

matchesGenerationRules in class TemplateSubTask

Parameters:

clazz -

Returns:

Throws:

XDocletException

See Also:

TemplateSubTask.matchesGenerationRules(xjavadoc.XClass)