de.smartics.testdoc.collect.extractor
Class TestDocMethodExtractor

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

public final class TestDocMethodExtractor
     
     

      
      extends 
      
      AbstractExtractor
     
     

Extracts unit test doc information from a specified method.

Author:

Robert Reiner

Field Summary

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

categoryExtractor, elementUtils, hintExtractor, sourceCodeHelper, testCaseType, uutExtractor

Constructor Summary

TestDocMethodExtractor(ExtractorConfig config, ExecutableElement declaredTestCaseMethod)
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

TestDocMethodExtractor

public TestDocMethodExtractor(ExtractorConfig config,
                              ExecutableElement declaredTestCaseMethod)
                       throws IllegalArgumentException

Default constructor.

Parameters:

config - the configuration to access processing information.

declaredTestCaseMethod - the element that contains information about a variable in the test case class that points to 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.