com.objectfab.tools.junitdoclet
Class JUnitDoclet

java.lang.Object
  extended by com.sun.javadoc.Doclet
      extended by com.objectfab.tools.junitdoclet.JUnitDoclet
All Implemented Interfaces:
JUnitDocletProperties

public class JUnitDoclet
extends com.sun.javadoc.Doclet
implements JUnitDocletProperties


Field Summary
private  boolean buildAll
           
protected static java.lang.String DEFAULT_SOURCE_PATH
           
private  com.sun.javadoc.DocErrorReporter docErrorReporter
           
private  boolean isTestInTest
           
private  NamingStrategy namingStrategy
           
private  java.lang.String namingStrategyName
           
protected static java.lang.String OPTION_BUILDALL
           
protected static java.lang.String OPTION_HELP
           
protected static java.lang.String OPTION_INPUT_DIR
           
protected static java.lang.String OPTION_NAMING
           
protected static java.lang.String OPTION_OUTPUT_DIR
           
protected static java.lang.String OPTION_PROPERTIES
           
protected static java.lang.String OPTION_SUBPACKAGE
           
protected static java.lang.String OPTION_TEST_IN_TEST
           
protected static java.lang.String OPTION_TESTING
           
protected static java.lang.String OPTION_WRITING
           
private  java.lang.String outputRoot
           
private  java.lang.String propertyFileName
           
private  java.lang.String sourcePath
           
private  java.lang.String subPackage
           
private  TestingStrategy testingStrategy
           
private  java.lang.String testingStrategyName
           
protected static java.lang.String USAGE_STRING
           
private  WritingStrategy writingStrategy
           
private  java.lang.String writingStrategyName
           
 
Fields inherited from interface com.objectfab.tools.junitdoclet.JUnitDocletProperties
ACCESSOR_GET_NAME, ACCESSOR_NAME, ACCESSOR_SET_NAME, ACCESSOR_TESTS, ACCESSOR_TYPE_NAME, ADD_IMPORT_NAME, ADD_IMPORT_TESTSUITE, ADD_TESTCASE_NAME, ADD_TESTCASE_TO_TESTSUITE, ADD_TESTSUITE_NAME, ADD_TESTSUITE_TO_TESTSUITE, CLASS_NAME, JUNIT_VERSION, LICENSE, MARKER_CLASS_BEGIN, MARKER_CLASS_END, MARKER_EXTENDS_IMPLEMENTS_BEGIN, MARKER_EXTENDS_IMPLEMENTS_END, MARKER_IMPORT_BEGIN, MARKER_IMPORT_END, MARKER_JAVADOC_CLASS_BEGIN, MARKER_JAVADOC_CLASS_END, MARKER_JAVADOC_METHOD_BEGIN, MARKER_JAVADOC_METHOD_END, MARKER_METHOD_BEGIN, MARKER_METHOD_END, METHOD_NAME, METHOD_SIGNATURE, PACKAGE_NAME, TEMPLATE_ATTRIBUTE_ACCESSOR, TEMPLATE_ATTRIBUTE_ARRAY, TEMPLATE_ATTRIBUTE_DEFAULT, TEMPLATE_NAME, TESTCASE_CLASS_NAME, TESTCASE_INSTANCE_NAME, TESTCASE_INSTANCE_TYPE, TESTCASE_METHOD_UNMATCHED, TESTCASE_PACKAGE_NAME, TESTCASE_TESTMETHODS, TESTCASE_UNMATCHED, TESTMETHOD_NAME, TESTSUITE_ADD_TESTCASES, TESTSUITE_ADD_TESTSUITES, TESTSUITE_CLASS_NAME, TESTSUITE_IMPORTS, TESTSUITE_INSTANCE_NAME, TESTSUITE_PACKAGE_NAME, VALUE_LICENSE, VALUE_MARKER_BEGIN, VALUE_MARKER_CLASS, VALUE_MARKER_CLASS_BEGIN, VALUE_MARKER_CLASS_END, VALUE_MARKER_END, VALUE_MARKER_EXTENDS_IMPLEMENTS, VALUE_MARKER_EXTENDS_IMPLEMENTS_BEGIN, VALUE_MARKER_EXTENDS_IMPLEMENTS_END, VALUE_MARKER_IMPORT, VALUE_MARKER_IMPORT_BEGIN, VALUE_MARKER_IMPORT_END, VALUE_MARKER_JAVADOC_CLASS, VALUE_MARKER_JAVADOC_CLASS_BEGIN, VALUE_MARKER_JAVADOC_CLASS_END, VALUE_MARKER_JAVADOC_METHOD, VALUE_MARKER_JAVADOC_METHOD_BEGIN, VALUE_MARKER_JAVADOC_METHOD_END, VALUE_MARKER_METHOD, VALUE_MARKER_METHOD_BEGIN, VALUE_MARKER_METHOD_END, VALUE_METHOD_UNMATCHED_NAME, VALUE_METHOD_UNMATCHED_NAME_MARKER
 
Constructor Summary
JUnitDoclet()
           
 
Method Summary
private  java.lang.Object createByClassName(java.lang.String className)
           
 boolean execute(com.sun.javadoc.RootDoc doc)
           
 NamingStrategy getNamingStrategy()
           
 java.lang.String getNamingStrategyName()
           
 java.lang.String getOutputRoot()
           
 java.lang.String getPropertyFileName()
           
 java.lang.String getSourcePath()
           
 java.lang.String getSubPackage()
           
 TestingStrategy getTestingStrategy()
           
 java.lang.String getTestingStrategyName()
           
 WritingStrategy getWritingStrategy()
           
 java.lang.String getWritingStrategyName()
           
 void init()
           
 boolean isBuildAll()
           
 boolean isGenerationNeeded(java.lang.String fullClassName, java.lang.String fullTestCaseName)
          Checks if file of application class is modified later than TestCase file.
static boolean isOutputMatchingAnySource(java.lang.String sourcePath, java.lang.String outputPath, com.sun.javadoc.DocErrorReporter reporter)
           
 boolean isTestInTest()
           
 boolean isWritingNeeded(java.lang.StringBuffer newCode, java.lang.StringBuffer oldCode)
           
static int optionLength(java.lang.String s)
           
private  void printError(java.lang.String msg)
           
private  void printNotice(java.lang.String msg)
           
private static void printUsage()
           
private  void printWarning(java.lang.String msg)
           
 boolean processClass(com.sun.javadoc.ClassDoc doc, com.sun.javadoc.PackageDoc packageDoc)
           
 boolean processPackage(com.sun.javadoc.PackageDoc[] docs, int index)
           
 void setBuildAll(boolean buildAll)
           
 void setDocErrorReporter(com.sun.javadoc.DocErrorReporter doc)
           
 void setNamingStrategy(NamingStrategy namingStrategy)
           
 void setNamingStrategyName(java.lang.String namingStrategyName)
           
 void setOptions(java.lang.String[][] options)
           
 void setOutputRoot(java.lang.String outputRoot)
           
 void setPropertyFileName(java.lang.String propertyFileName)
           
 void setSourcePath(java.lang.String theSourcePath)
           
 void setSubPackage(java.lang.String subPackage)
           
 void setTestingStrategy(TestingStrategy testingStrategy)
           
 void setTestingStrategyName(java.lang.String testingStrategyName)
           
 void setTestInTest(boolean testInTest)
           
 void setWritingStrategy(WritingStrategy writingStrategy)
           
 void setWritingStrategyName(java.lang.String writingStrategyName)
           
static boolean start(com.sun.javadoc.RootDoc doc)
           
static boolean validOptions(java.lang.String[][] strings, com.sun.javadoc.DocErrorReporter reporter)
           
 
Methods inherited from class com.sun.javadoc.Doclet
languageVersion
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPTION_INPUT_DIR

protected static final java.lang.String OPTION_INPUT_DIR
See Also:
Constant Field Values

OPTION_OUTPUT_DIR

protected static final java.lang.String OPTION_OUTPUT_DIR
See Also:
Constant Field Values

OPTION_PROPERTIES

protected static final java.lang.String OPTION_PROPERTIES
See Also:
Constant Field Values

OPTION_TESTING

protected static final java.lang.String OPTION_TESTING
See Also:
Constant Field Values

OPTION_WRITING

protected static final java.lang.String OPTION_WRITING
See Also:
Constant Field Values

OPTION_NAMING

protected static final java.lang.String OPTION_NAMING
See Also:
Constant Field Values

OPTION_BUILDALL

protected static final java.lang.String OPTION_BUILDALL
See Also:
Constant Field Values

OPTION_HELP

protected static final java.lang.String OPTION_HELP
See Also:
Constant Field Values

OPTION_SUBPACKAGE

protected static final java.lang.String OPTION_SUBPACKAGE
See Also:
Constant Field Values

OPTION_TEST_IN_TEST

protected static final java.lang.String OPTION_TEST_IN_TEST
See Also:
Constant Field Values

DEFAULT_SOURCE_PATH

protected static final java.lang.String DEFAULT_SOURCE_PATH
See Also:
Constant Field Values

USAGE_STRING

protected static final java.lang.String USAGE_STRING
See Also:
Constant Field Values

sourcePath

private java.lang.String sourcePath

outputRoot

private java.lang.String outputRoot

namingStrategy

private NamingStrategy namingStrategy

writingStrategy

private WritingStrategy writingStrategy

testingStrategy

private TestingStrategy testingStrategy

namingStrategyName

private java.lang.String namingStrategyName

writingStrategyName

private java.lang.String writingStrategyName

testingStrategyName

private java.lang.String testingStrategyName

propertyFileName

private java.lang.String propertyFileName

subPackage

private java.lang.String subPackage

buildAll

private boolean buildAll

isTestInTest

private boolean isTestInTest

docErrorReporter

private com.sun.javadoc.DocErrorReporter docErrorReporter
Constructor Detail

JUnitDoclet

public JUnitDoclet()
Method Detail

init

public void init()

getSourcePath

public java.lang.String getSourcePath()

setSourcePath

public void setSourcePath(java.lang.String theSourcePath)

getOutputRoot

public java.lang.String getOutputRoot()

setOutputRoot

public void setOutputRoot(java.lang.String outputRoot)

getPropertyFileName

public java.lang.String getPropertyFileName()

setPropertyFileName

public void setPropertyFileName(java.lang.String propertyFileName)

getNamingStrategy

public NamingStrategy getNamingStrategy()

setNamingStrategy

public void setNamingStrategy(NamingStrategy namingStrategy)

getWritingStrategy

public WritingStrategy getWritingStrategy()

setWritingStrategy

public void setWritingStrategy(WritingStrategy writingStrategy)

getTestingStrategy

public TestingStrategy getTestingStrategy()

setTestingStrategy

public void setTestingStrategy(TestingStrategy testingStrategy)

getNamingStrategyName

public java.lang.String getNamingStrategyName()

setNamingStrategyName

public void setNamingStrategyName(java.lang.String namingStrategyName)

getWritingStrategyName

public java.lang.String getWritingStrategyName()

setWritingStrategyName

public void setWritingStrategyName(java.lang.String writingStrategyName)

getTestingStrategyName

public java.lang.String getTestingStrategyName()

setTestingStrategyName

public void setTestingStrategyName(java.lang.String testingStrategyName)

isBuildAll

public boolean isBuildAll()

setBuildAll

public void setBuildAll(boolean buildAll)

isTestInTest

public boolean isTestInTest()

setTestInTest

public void setTestInTest(boolean testInTest)

getSubPackage

public java.lang.String getSubPackage()

setSubPackage

public void setSubPackage(java.lang.String subPackage)

createByClassName

private java.lang.Object createByClassName(java.lang.String className)

processPackage

public boolean processPackage(com.sun.javadoc.PackageDoc[] docs,
                              int index)

processClass

public boolean processClass(com.sun.javadoc.ClassDoc doc,
                            com.sun.javadoc.PackageDoc packageDoc)

isGenerationNeeded

public boolean isGenerationNeeded(java.lang.String fullClassName,
                                  java.lang.String fullTestCaseName)
Checks if file of application class is modified later than TestCase file.


isWritingNeeded

public boolean isWritingNeeded(java.lang.StringBuffer newCode,
                               java.lang.StringBuffer oldCode)

start

public static boolean start(com.sun.javadoc.RootDoc doc)

setDocErrorReporter

public void setDocErrorReporter(com.sun.javadoc.DocErrorReporter doc)

execute

public boolean execute(com.sun.javadoc.RootDoc doc)

setOptions

public void setOptions(java.lang.String[][] options)

optionLength

public static int optionLength(java.lang.String s)

validOptions

public static boolean validOptions(java.lang.String[][] strings,
                                   com.sun.javadoc.DocErrorReporter reporter)

isOutputMatchingAnySource

public static boolean isOutputMatchingAnySource(java.lang.String sourcePath,
                                                java.lang.String outputPath,
                                                com.sun.javadoc.DocErrorReporter reporter)

printUsage

private static void printUsage()

printError

private void printError(java.lang.String msg)

printWarning

private void printWarning(java.lang.String msg)

printNotice

private void printNotice(java.lang.String msg)