de.smartics.testdoc.collect.extractor
Class TestDocTypeExtractor

java.lang.Object
  de.smartics.testdoc.collect.extractor.AbstractExtractor
      de.smartics.testdoc.collect.extractor.TestDocTypeExtractor

public final class TestDocTypeExtractor
     
     

      
      extends 
      
      AbstractExtractor
     
     

Extracts unit test doc information from a specified type.

Author:

Robert Reiner

Field Summary

Fields inherited from class de.smartics.testdoc.collect.extractor.AbstractExtractor

categoryExtractor, elementUtils, hintExtractor, sourceCodeHelper, testCaseType, uutExtractor

Constructor Summary

TestDocTypeExtractor(ExtractorConfig config, TypeElement testCaseType)
Default constructor.

Method Summary

UnitTestDoc

readTestDoc() Reads the test documentation from the element the extractor instance is associated with.

Methods inherited from class de.smartics.testdoc.collect.extractor.AbstractExtractor

calculateTestSentence, createScenarioIfElementIsTestMethod, hasAnnotation, hasNotAnnotation, isTestMethodWithoutUutAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

TestDocTypeExtractor

public TestDocTypeExtractor(ExtractorConfig config,
                            TypeElement testCaseType)
                     throws IllegalArgumentException

Default constructor.

Parameters:

config - the configuration to access processing information.

testCaseType - the test case that has an annotation that potentially specifies the unit under test.

Throws:

IllegalArgumentException - if the declaredUutField is not a field declaration within a class or any of the arguments is null.

Method Detail

readTestDoc

public UnitTestDoc readTestDoc()

Reads the test documentation from the element the extractor instance is associated with.

Specified by:

readTestDoc in class AbstractExtractor

Returns:

the test documentation read, null if no information is found in class.