Index (testdoc-core 0.4.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV NEXT

FRAMES NO FRAMES

A B C D E F G H I J L M O P R S T U V X

A

AbstractExportAdapter - Class in de.smartics.testdoc.core.export: Base implementation of the ExportAdapter interface.
AbstractExportAdapter() - Constructor for class de.smartics.testdoc.core.export. AbstractExportAdapter: Default constructor.
AbstractExtractor - Class in de.smartics.testdoc.collect.extractor: Base implementation for Extracting unit test doc information.
AbstractExtractor(ExtractorConfig, TypeElement) - Constructor for class de.smartics.testdoc.collect.extractor. AbstractExtractor: Default constructor.
AbstractFileBasedExportAdapter - Class in de.smartics.testdoc.core.adapter: Exports the documentation fragments to a directory via the APT filer.
AbstractFileBasedExportAdapter() - Constructor for class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter: Default constructor.
AbstractInMemoryExportAdapter - Class in de.smartics.testdoc.core.adapter: Exports the documentation to an in-memory singleton.
AbstractInMemoryExportAdapter(UnitTestDocIndex) - Constructor for class de.smartics.testdoc.core.adapter. AbstractInMemoryExportAdapter: Inheritance constructor to allow subclasses to pass in the reference to the index.
AbstractOutputManager - Class in de.smartics.testdoc.core.export: Base implementation of the OutputManager interface.
AbstractOutputManager(UnitTestDocExporter) - Constructor for class de.smartics.testdoc.core.export. AbstractOutputManager: Default constructor.
addLoader(IndexProvider.UnitTestDocLoader) - Method in class de.smartics.testdoc.core.adapter. MultiUnitTestDocLoader: Adds the loader to the multi loader.
addScenario(ScenarioTestDoc) - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Adds the test documentation to the documentation of the unit-under-test.
addScenarios(UnitTestDoc) - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Adds all scenarios of the given test doc to this instance.

B

BasedFilerSingletonInMemoryExportAdapter - Class in de.smartics.testdoc.core.adapter: A Filer based adapter that has an in-memory representation of the export adapter.
BasedFilerSingletonInMemoryExportAdapter(Filer) - Constructor for class de.smartics.testdoc.core.adapter. BasedFilerSingletonInMemoryExportAdapter: Default constructor.
BlankArgumentException - Exception in de.smartics.testdoc.core: Signals that a given String argument is blank where is must no be blank.
BlankArgumentException(String) - Constructor for exception de.smartics.testdoc.core. BlankArgumentException: Default constructor.

C

calcTestCaseType(UnitTestDoc) - Method in class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter: Assumes that all scenarios belong to the same test case type.
calculateTestNameSentence(String) - Method in class de.smartics.testdoc.core.doc.names. CaseSensitiveTestNameUtils: The implementation dependent translation of the test name into a sentence.
calculateTestNameSentence(String) - Method in class de.smartics.testdoc.core.doc.names. EnglishTestNameUtils: The implementation dependent translation of the test name into a sentence.
calculateTestNameSentence(String) - Method in interface de.smartics.testdoc.core.doc.names. TestNameUtils: The implementation dependent translation of the test name into a sentence.
calculateTestSentence(TestDocHintsExtractor.Hints, String) - Method in class de.smartics.testdoc.collect.extractor. AbstractExtractor
CaseSensitiveTestNameUtils - Class in de.smartics.testdoc.core.doc.names: Calculates valid names for test names written in a case sensitive language.
CaseSensitiveTestNameUtils() - Constructor for class de.smartics.testdoc.core.doc.names. CaseSensitiveTestNameUtils: Default constructor.
categoryExtractor - Variable in class de.smartics.testdoc.collect.extractor. AbstractExtractor: Extracts category information.
clear(Type) - Method in class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter: Removes documentation already exported for the given test case type.
clear(Type) - Method in class de.smartics.testdoc.core.adapter. AbstractInMemoryExportAdapter: Removes documentation already exported for the given test case type.
clear() - Static method in class de.smartics.testdoc.core.adapter. GlobalUnitTestDocIndex
clear(Type) - Method in class de.smartics.testdoc.core.adapter. JmxExportAdapterClient: Removes documentation already exported for the given test case type.
clear(Type) - Method in class de.smartics.testdoc.core.adapter. MultiExportAdapter: Removes documentation already exported for the given test case type.
clear() - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Clears the index.
clear(Type) - Method in interface de.smartics.testdoc.core.export. ExportAdapter: Removes documentation already exported for the given test case type.
compare(UnitTestDoc, UnitTestDoc) - Method in class de.smartics.testdoc.core.doc. UnitTestDocNaturalComparator
compare(UnitTestDoc, UnitTestDoc) - Method in class de.smartics.testdoc.core.doc. UnitTestDocTypeSimpleNameComparator
compareTo(ScenarioTestDoc) - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: The natural order is defined by the SortKey property.
compareTo(SortKey) - Method in class de.smartics.testdoc.core.doc. SortKey: Compares the main key before the index key.
compareTo(Type) - Method in class de.smartics.testdoc.core.doc. Type: Defines the lexicographical order on packages and type names.
compareTo(UnitTestDoc) - Method in class de.smartics.testdoc.core.doc. UnitTestDoc
create() - Method in class de.smartics.testdoc.core.source. SourceCodeHelperFactory: Creates an instance of the source code helper.
createDirectoryRef(Type) - Method in class de.smartics.testdoc.core.doc. FileHelper
createFileRef(Type, Type) - Method in class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter
createFileRef(Type, Type) - Method in class de.smartics.testdoc.core.adapter. DirectoryExportAdapter
createFileRef(Type, Type) - Method in class de.smartics.testdoc.core.adapter. FilerExportAdapter
createFileRefs(Type) - Method in class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter
createFileRefs(Type, File) - Method in class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter
createFileRefs(Type) - Method in class de.smartics.testdoc.core.adapter. DirectoryExportAdapter
createFileRefs(Type) - Method in class de.smartics.testdoc.core.adapter. FilerExportAdapter
createScenarioIfElementIsTestMethod(TestDocAnnotationExtractor.UutInfo, String, ExecutableElement) - Method in class de.smartics.testdoc.collect.extractor. AbstractExtractor

D

de.smartics.testdoc.collect.extractor - package de.smartics.testdoc.collect.extractor: Provides helper classes to extract information from the APT interface.
de.smartics.testdoc.collect.generator - package de.smartics.testdoc.collect.generator: Provides helper to interface with the compiler and APT API.
de.smartics.testdoc.collect.processor - package de.smartics.testdoc.collect.processor
de.smartics.testdoc.core - package de.smartics.testdoc.core: Provides base classes of the report library.
de.smartics.testdoc.core.adapter - package de.smartics.testdoc.core.adapter: Provides adapters to interface to the information collected by the APT processor.
de.smartics.testdoc.core.doc - package de.smartics.testdoc.core.doc: Provides classes to store the gathered test documentation.
de.smartics.testdoc.core.doc.names - package de.smartics.testdoc.core.doc.names: Provides classes to transform the names of test methods into human readable sentences.
de.smartics.testdoc.core.export - package de.smartics.testdoc.core.export: Provides a mini framework to export test documentation.
de.smartics.testdoc.core.source - package de.smartics.testdoc.core.source: Provides helpers to locate source code fragments.
deregisterTestCase(Type) - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Removes all scenarios of the given test case type.
deserialize(InputStream) - Method in class de.smartics.testdoc.core.adapter. PersistenceUtils: Deserializes a single object from the given stream.
deserialize(File) - Method in class de.smartics.testdoc.core.adapter. PersistenceUtils: Deserializes a single object from the given file.
deserialize(FileObject) - Method in class de.smartics.testdoc.core.adapter. PersistenceUtils: Deserializes a single object from the given file.
DirectoryExportAdapter - Class in de.smartics.testdoc.core.adapter: Exports the documentation fragments to a directory.
DirectoryExportAdapter(File) - Constructor for class de.smartics.testdoc.core.adapter. DirectoryExportAdapter: Default constructor.
DirectoryUnitTestDocLoader - Class in de.smartics.testdoc.core.adapter: Loads instances of UnitTestDoc from a file system directory.
DirectoryUnitTestDocLoader(File) - Constructor for class de.smartics.testdoc.core.adapter. DirectoryUnitTestDocLoader: Default constructor.
DummySourceCodeHelper - Class in de.smartics.testdoc.core.source: Dummy implementation of the SourceCodeHelper interface that is not able to determine source code locations.
DummySourceCodeHelper() - Constructor for class de.smartics.testdoc.core.source. DummySourceCodeHelper: Default constructor.

E

elementUtils - Variable in class de.smartics.testdoc.collect.extractor. AbstractExtractor: The utilities of the APT interface.
EnglishTestNameUtils - Class in de.smartics.testdoc.core.doc.names: Calculates valid names for test names written in English.
EnglishTestNameUtils() - Constructor for class de.smartics.testdoc.core.doc.names. EnglishTestNameUtils: Default constructor.
equals(Object) - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns true if the given object is semantically equal to the given object, false otherwise.
equals(Object) - Method in class de.smartics.testdoc.core.doc. SortKey: Returns true if the given object is semantically equal to the given object, false otherwise.
equals(Object) - Method in class de.smartics.testdoc.core.doc. TestMethodDoc: Returns true if the given object is semantically equal to the given object, false otherwise.
equals(Object) - Method in class de.smartics.testdoc.core.doc. Type: Returns true if the given object is semantically equal to the given object, false otherwise.
equals(Object) - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Returns true if the given object is semantically equal to the given object, false otherwise.
export(UnitTestDoc) - Method in class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter: Exports the documentation to the implementation dependent destination.
export(UnitTestDoc) - Method in class de.smartics.testdoc.core.adapter. AbstractInMemoryExportAdapter: Exports the documentation to the implementation dependent destination.
export(UnitTestDoc) - Method in class de.smartics.testdoc.core.adapter. JmxExportAdapterClient: Exports the documentation to the implementation dependent destination.
export(UnitTestDoc) - Method in class de.smartics.testdoc.core.adapter. MultiExportAdapter: Exports the documentation to the implementation dependent destination.
export(UnitTestDoc) - Method in interface de.smartics.testdoc.core.doc. OutputManager: Exports the given test documentation.
export(UnitTestDoc) - Method in class de.smartics.testdoc.core.export. AbstractOutputManager: Exports the given test documentation.
export(UnitTestDoc) - Method in interface de.smartics.testdoc.core.export. ExportAdapter: Exports the documentation to the implementation dependent destination.
export(UnitTestDoc, OutputStream) - Method in interface de.smartics.testdoc.core.export. UnitTestDocExporter: Exports the given test documentation to the stream.
export(UnitTestDocIndex) - Method in class de.smartics.testdoc.core.export. UnitTestDocIndexExporter: Exports the index to it external form.
export(UnitTestDoc, OutputStream) - Method in class de.smartics.testdoc.core.export. XmlExporter: Exports the given test documentation to the stream.
ExportAdapter - Interface in de.smartics.testdoc.core.export: Allows to export the information gathered by the TestDocProcessor.
exporter - Variable in class de.smartics.testdoc.core.export. AbstractOutputManager: The exporter that knows the format of the file to be written.
ExportException - Exception in de.smartics.testdoc.core.export: Signals problems performing the export of unit test documentation.
ExportException(String) - Constructor for exception de.smartics.testdoc.core.export. ExportException: Constructor.
ExportException(Throwable) - Constructor for exception de.smartics.testdoc.core.export. ExportException: Constructor.
ExportException(String, Throwable) - Constructor for exception de.smartics.testdoc.core.export. ExportException: Constructor.
exportQuietly(UnitTestDoc) - Method in class de.smartics.testdoc.core.export. AbstractExportAdapter: Exports the documentation to the implementation dependent destination, suppressing any exceptions raised.
exportQuietly(UnitTestDoc) - Method in interface de.smartics.testdoc.core.export. ExportAdapter: Exports the documentation to the implementation dependent destination, suppressing any exceptions raised.
ExtractorConfig - Class in de.smartics.testdoc.collect.extractor: Contains helpers to access processing configuration.
ExtractorConfig(Elements, SourceCodeHelper, TestNameUtils) - Constructor for class de.smartics.testdoc.collect.extractor. ExtractorConfig: Default constructor.
ExtractorException - Exception in de.smartics.testdoc.collect.extractor: Signals that the extactor cannot extract the test documentation information.
ExtractorException(String) - Constructor for exception de.smartics.testdoc.collect.extractor. ExtractorException: Constructor.
ExtractorException(Throwable) - Constructor for exception de.smartics.testdoc.collect.extractor. ExtractorException: Constructor.
ExtractorException(String, Throwable) - Constructor for exception de.smartics.testdoc.collect.extractor. ExtractorException: Constructor.

F

FileHelper - Class in de.smartics.testdoc.core.doc: Helps with creating directories and files.
FileHelper(File, String) - Constructor for class de.smartics.testdoc.core.doc. FileHelper: Convenience constructor selecting the option to overwrite.
FileHelper(File, String, boolean) - Constructor for class de.smartics.testdoc.core.doc. FileHelper: Default constructor.
FileOutputManager - Class in de.smartics.testdoc.core.export: Writes to files.
FileOutputManager(File, UnitTestDocExporter) - Constructor for class de.smartics.testdoc.core.export. FileOutputManager: Default constructor.
FilerExportAdapter - Class in de.smartics.testdoc.core.adapter: Exports the documentation fragments to a directory via the APT filer.
FilerExportAdapter(Filer) - Constructor for class de.smartics.testdoc.core.adapter. FilerExportAdapter: Default constructor.
finish() - Method in interface de.smartics.testdoc.core.doc. OutputManager: Signals the manager that no more test documentation instances will be passed to it.
finish() - Method in class de.smartics.testdoc.core.export. AbstractOutputManager: Signals the manager that no more test documentation instances will be passed to it.

G

generate() - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator: Generates the test documentation.
get(Type) - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Returns the unit test documentation for the given UUT type.
getByTestCase(Type) - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Returns the list of UUT documentation whose UUT is tested by the given test case.
getCategories() - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns the categories of the scenario.
getCompilerOptions() - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config
getComponentName() - Method in enum de.smartics.testdoc.core. TestDocProperty
getDefaultValue() - Method in enum de.smartics.testdoc.core. TestDocProperty: Returns the default value to use if a given property is not specified.
getElementUtils() - Method in class de.smartics.testdoc.collect.extractor. ExtractorConfig: Returns the utilities of the APT interface.
getFileExtension() - Method in interface de.smartics.testdoc.core.export. UnitTestDocExporter: Returns the extension for the files being exported by this instance.
getFileExtension() - Method in class de.smartics.testdoc.core.export. XmlExporter: Returns the extension for the files being exported by this instance.
getId() - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns a unique identifier for a test method.
getIndex() - Method in class de.smartics.testdoc.core.adapter. AbstractInMemoryExportAdapter: Returns the index that stores the exported documentation.
getIndex() - Static method in class de.smartics.testdoc.core.adapter. GlobalUnitTestDocIndex: Returns the index of test documentation this singleton contains.
getIndex() - Method in interface de.smartics.testdoc.core.adapter. IndexProvider: Returns the index that stores the exported documentation.
getIndex() - Method in interface de.smartics.testdoc.core.adapter. JmxExportAdapterMBean: Provides access to the index.
getIndex() - Method in class de.smartics.testdoc.core.adapter. SingletonInMemoryExportAdapter: Provides access to the singleton.
getIndexKey() - Method in class de.smartics.testdoc.core.doc. SortKey: Returns the key within the main key.
getIndexOnStream() - Method in class de.smartics.testdoc.core.adapter. JmxExportAdapter: Provides access to the index.
getIndexOnStream() - Method in interface de.smartics.testdoc.core.adapter. JmxExportAdapterMBean: Provides access to the index.
getJavadocComment() - Method in class de.smartics.testdoc.core.doc. TestMethodDoc: Returns the optional Javadoc comment of the test method.
getLocation() - Method in class de.smartics.testdoc.core.doc. TestMethodDoc: Returns the location of the test.
getMainKey() - Method in class de.smartics.testdoc.core.doc. SortKey: Returns the main key part of the sort key that controls the index key.
getMethodSignature() - Method in class de.smartics.testdoc.core.doc. TestMethodDoc: Returns the signature of the test method.
getName() - Method in class de.smartics.testdoc.core.adapter. JmxExportAdapterClient: Returns the JMX object name to retrieve the instance from the server.
getName() - Method in enum de.smartics.testdoc.core. TestDocProperty: Returns the property name.
getPackageName() - Method in class de.smartics.testdoc.core.doc. Type: Returns the package part of the type name.
getScenarioCount() - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Returns the number of registered scenarios.
getScenarios() - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Returns the test documentation of the individual tests of the unit.
getSize() - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Returns the number of registered unit test documentation.
getSortedScenarios() - Method in class de.smartics.testdoc.core.doc. UnitTestDoc
getSortKey() - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns the sort key defining the natural order of scenarios.
getSourceCodeHelper() - Method in class de.smartics.testdoc.collect.extractor. ExtractorConfig: Returns the helper to access source code information.
getSourceCodeLocation(Element) - Method in class de.smartics.testdoc.core.source. DummySourceCodeHelper: Returns SourceCodeLocation.UNKNOWN_LOCATION.
getSourceCodeLocation(Element) - Method in interface de.smartics.testdoc.core.source. SourceCodeHelper: Returns the location of the element in the source code.
getSourceCodeLocation(Element) - Method in class de.smartics.testdoc.core.source. SunSourceCodeHelper: Returns the location of the element in the source code.
getSupportedOptions() - Method in class de.smartics.testdoc.collect.processor. TestDocProcessor
getTestCaseType() - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns the type of the test case the test has been specified in.
getTestMethod() - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns the test method of a scenario.
getTestName() - Method in class de.smartics.testdoc.core.doc. TestMethodDoc: Returns the name of the test.
getTestNameUtils() - Method in class de.smartics.testdoc.collect.extractor. ExtractorConfig: Returns the utilities to create names to be displayed (as labels) for tests.
getTestSentence() - Method in class de.smartics.testdoc.core.doc. TestMethodDoc: Returns the name of the test translated to a human readable sentence.
getType() - Method in enum de.smartics.testdoc.core. TestDocProperty
getTypeName() - Method in class de.smartics.testdoc.core.doc. Type: Returns the name of the type without the package part.
getUnitTestDocs() - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Returns a copy of the internal map that contains the test documentation instances.
getUutMethod() - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns the name of the method under test.
getUutType() - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Returns the type of the unit-under-test.
getValueRange() - Method in enum de.smartics.testdoc.core. TestDocProperty
GlobalUnitTestDocIndex - Class in de.smartics.testdoc.core.adapter: A singleton that stores the UnitTestDocIndex to be globally accessible within a VM.

H

hasAnnotation(Element, Class<? extends Annotation>) - Static method in class de.smartics.testdoc.collect.extractor. AbstractExtractor
hashCode() - Method in class de.smartics.testdoc.core.doc. ScenarioTestDoc: Returns the hash code of the object.
hashCode() - Method in class de.smartics.testdoc.core.doc. SortKey: Returns the hash code of the object.
hashCode() - Method in class de.smartics.testdoc.core.doc. TestMethodDoc: Delegates call to String.hashCode().
hashCode() - Method in class de.smartics.testdoc.core.doc. Type: Returns the hash code of the object.
hashCode() - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Returns the hash code of the object.
hasNotAnnotation(Element, Class<? extends Annotation>) - Static method in class de.smartics.testdoc.collect.extractor. AbstractExtractor
hintExtractor - Variable in class de.smartics.testdoc.collect.extractor. AbstractExtractor: Extracts hint information.

I

ImportException - Exception in de.smartics.testdoc.core.adapter: Signals problems performing the import of unit test documentation.
ImportException(String) - Constructor for exception de.smartics.testdoc.core.adapter. ImportException: Constructor.
ImportException(Throwable) - Constructor for exception de.smartics.testdoc.core.adapter. ImportException: Constructor.
ImportException(String, Throwable) - Constructor for exception de.smartics.testdoc.core.adapter. ImportException: Constructor.
IndexProvider - Interface in de.smartics.testdoc.core.adapter: Provides access to an instance of UnitTestDocIndex.
IndexProvider.UnitTestDocLoader - Interface in de.smartics.testdoc.core.adapter: Loader to fill an {@link IndexProvider.
init(ProcessingEnvironment) - Method in class de.smartics.testdoc.collect.processor. TestDocProcessor
init() - Method in interface de.smartics.testdoc.core.doc. OutputManager: Signals the manager to initialize.
init() - Method in class de.smartics.testdoc.core.export. AbstractOutputManager: Signals the manager to initialize.
isDefault() - Method in class de.smartics.testdoc.core.doc. SortKey: Checks if the sort key is condfigured or not.
isEmpty() - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Checks whether the index contains elements or not.
isMandatory() - Method in enum de.smartics.testdoc.core. TestDocProperty
isTestMethodWithoutUutAnnotation(Element) - Static method in class de.smartics.testdoc.collect.extractor. AbstractExtractor

J

JmxExportAdapter - Class in de.smartics.testdoc.core.adapter: Provides an in-memory adapter to be exposed via JMX.
JmxExportAdapter() - Constructor for class de.smartics.testdoc.core.adapter. JmxExportAdapter: Default constructor.
JmxExportAdapterClient - Class in de.smartics.testdoc.core.adapter: The client to the JMX bean stored at the MBean server.
JmxExportAdapterClient() - Constructor for class de.smartics.testdoc.core.adapter. JmxExportAdapterClient: Default constructor.
JmxExportAdapterMBean - Interface in de.smartics.testdoc.core.adapter: Managing interface to the export adapter.

L

listFiles() - Method in class de.smartics.testdoc.core.doc. FileHelper
load(IndexProvider.UnitTestDocLoader) - Method in class de.smartics.testdoc.core.adapter. AbstractInMemoryExportAdapter: Loads instances of unit test documentation from the loader.
load() - Method in class de.smartics.testdoc.core.adapter. DirectoryUnitTestDocLoader: Loads instances of unit test documentation from a backend.
load(IndexProvider.UnitTestDocLoader) - Method in interface de.smartics.testdoc.core.adapter. IndexProvider: Loads instances of unit test documentation from the loader.
load() - Method in interface de.smartics.testdoc.core.adapter. IndexProvider.UnitTestDocLoader: Loads instances of unit test documentation from a backend.
load() - Method in class de.smartics.testdoc.core.adapter. MultiUnitTestDocLoader: Loads instances of unit test documentation from a backend.

M

MultiExportAdapter - Class in de.smartics.testdoc.core.adapter: Allows to configure a number of export adapter that will be used as delegates.
MultiExportAdapter(List<ExportAdapter>) - Constructor for class de.smartics.testdoc.core.adapter. MultiExportAdapter: Default constructor.
MultiExportAdapter(ExportAdapter...) - Constructor for class de.smartics.testdoc.core.adapter. MultiExportAdapter: Convenience varargs constructor.
MultiUnitTestDocLoader - Class in de.smartics.testdoc.core.adapter: Loads instances of UnitTestDoc from multiple loaders.
MultiUnitTestDocLoader() - Constructor for class de.smartics.testdoc.core.adapter. MultiUnitTestDocLoader: Default constructor.

O

OBJECT_NAME - Static variable in class de.smartics.testdoc.core.adapter. JmxExportAdapterClient: The name that registers the instance of JmxExportAdapterMBean.
openStreamFor(UnitTestDoc) - Method in class de.smartics.testdoc.core.export. AbstractOutputManager: Creates a stream to write the given document to.
openStreamFor(UnitTestDoc) - Method in class de.smartics.testdoc.core.export. FileOutputManager: Creates a stream to write the given document to.
OutputManager - Interface in de.smartics.testdoc.core.doc: Manages writing test documentation to a store.

P

persist - Variable in class de.smartics.testdoc.core.adapter. AbstractFileBasedExportAdapter: Helper to serialize instances of UnitTestDoc to files.
PersistenceUtils - Class in de.smartics.testdoc.core.adapter: Provides means to persist the state of collected test documentation information.
PersistenceUtils() - Constructor for class de.smartics.testdoc.core.adapter. PersistenceUtils
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class de.smartics.testdoc.collect.processor. TestDocProcessor
processElements(RoundEnvironment, TypeElement) - Method in class de.smartics.testdoc.collect.processor. UutProcess
provideDir(File) - Static method in class de.smartics.testdoc.core.doc. FileHelper
provideFile(Type) - Method in class de.smartics.testdoc.core.doc. FileHelper
provideFile(Type, Type) - Method in class de.smartics.testdoc.core.doc. FileHelper

R

readTestDoc() - Method in class de.smartics.testdoc.collect.extractor. AbstractExtractor: Reads the test documentation from the element the extractor instance is associated with.
readTestDoc() - Method in class de.smartics.testdoc.collect.extractor. TestDocMethodExtractor: Reads the test documentation from the element the extractor instance is associated with.
readTestDoc() - Method in class de.smartics.testdoc.collect.extractor. TestDocTypeExtractor: Reads the test documentation from the element the extractor instance is associated with.
readTestDoc() - Method in class de.smartics.testdoc.collect.extractor. TestDocVariableExtractor: Reads the test documentation from the element the extractor instance is associated with.
register(UnitTestDoc) - Method in class de.smartics.testdoc.core.doc. UnitTestDocIndex: Registers the given test documentation to the index.
removeScenarios(Type) - Method in class de.smartics.testdoc.core.doc. UnitTestDoc: Removes all scenarios that are associated with the given test case.
runGenerator(TestDocGenerator.Config.Builder) - Static method in class de.smartics.testdoc.collect.generator. TestDocGenerator: Convenience method to create an instance of the generator by the builder information.

S

ScenarioTestDoc - Class in de.smartics.testdoc.core.doc: The test documentation of a single scenario of a unit-under-test.
ScenarioTestDoc(String, TestMethodDoc) - Constructor for class de.smartics.testdoc.core.doc. ScenarioTestDoc: Convenience constructor specifying the test case type as a String .
ScenarioTestDoc(String, String, TestMethodDoc) - Constructor for class de.smartics.testdoc.core.doc. ScenarioTestDoc: Convenience constructor specifying the test case type as a String .
ScenarioTestDoc(String, String, TestMethodDoc, List<String>) - Constructor for class de.smartics.testdoc.core.doc. ScenarioTestDoc: Convenience constructor specifying the test case type as a String .
ScenarioTestDoc(String, Type, TestMethodDoc) - Constructor for class de.smartics.testdoc.core.doc. ScenarioTestDoc: Convenience constructor.
ScenarioTestDoc(Type, TestMethodDoc, List<String>) - Constructor for class de.smartics.testdoc.core.doc. ScenarioTestDoc: Convenience constructor.
ScenarioTestDoc(String, Type, TestMethodDoc, List<String>, SortKey) - Constructor for class de.smartics.testdoc.core.doc. ScenarioTestDoc: Default constructor.
serialize(Object, OutputStream) - Method in class de.smartics.testdoc.core.adapter. PersistenceUtils: Serializes the index.
serialize(Object, FileObject) - Method in class de.smartics.testdoc.core.adapter. PersistenceUtils: Serializes the instance to the given file.
serialize(UnitTestDoc, File) - Method in class de.smartics.testdoc.core.adapter. PersistenceUtils: Serializes the test doc instance to the given file.
setCharset(Charset) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder: Sets the charset to read the source files.
setCharsetByEncoding(String) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder: Sets the charset to read the source files by the name of the character encoding.
setClassPathElements(List<String>) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder
setExportAdapterName(String) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder: Sets the name of the export adapter to use.
setExportAdapterName(Class<? extends ExportAdapter>) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder: Sets the name of the export adapter to use.
setLocale(Locale) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder: Sets the locale to read the source files.
setRootDirs(Collection<File>) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder: Sets the root directories that contain the source files to process.
setRootDirsAsString(Collection<String>) - Method in class de.smartics.testdoc.collect.generator. TestDocGenerator.Config.Builder: Sets the root directories that contain the source files to process.
SingletonInMemoryExportAdapter - Class in de.smartics.testdoc.core.adapter: Exports the documentation to an in-memory singleton.
SingletonInMemoryExportAdapter() - Constructor for class de.smartics.testdoc.core.adapter. SingletonInMemoryExportAdapter: Default constructor.
SortKey - Class in de.smartics.testdoc.core.doc: A key to attach to an entity for sorting.
SortKey(String, String) - Constructor for class de.smartics.testdoc.core.doc. SortKey: Default constructor.
sourceCodeHelper - Variable in class de.smartics.testdoc.collect.extractor. AbstractExtractor: The helper to access source code information.
SourceCodeHelper - Interface in de.smartics.testdoc.core.source: Helper to extract source code information.
SourceCodeHelperFactory - Class in de.smartics.testdoc.core.source: A factory to create instances of SourceCodeHelpers.
SourceCodeHelperFactory(ProcessingEnvironment) - Constructor for class de.smartics.testdoc.core.source. SourceCodeHelperFactory: Default constructor.
SunSourceCodeHelper - Class in de.smartics.testdoc.core.source: Implementation of the SourceCodeHelper interface that uses the AST implementation of com.sun.source.
SunSourceCodeHelper(Trees) - Constructor for class de.smartics.testdoc.core.source.SunSourceCodeHelper: Default constructor.

 
   
  
     T 
    
     
     testCaseType - Variable in class de.smartics.testdoc.collect.extractor. 
     AbstractExtractor 
     
    
      The test case that is analyzed. 
     
     
     TestDocGenerator - Class in 
     de.smartics.testdoc.collect.generator 
     
    
      Run the generation of the test documentation files. 
     
     
     TestDocGenerator(TestDocGenerator.Config) - Constructor for class de.smartics.testdoc.collect.generator. 
     TestDocGenerator 
     
    
      Default constructor. 
     
     
     TestDocGenerator.Config - Class in 
     de.smartics.testdoc.collect.generator 
     
    
      The configuration to control the generation process. 
     
     
     TestDocGenerator.Config.Builder - Class in 
     de.smartics.testdoc.collect.generator 
     
    
      The builder to collect information and construct the config instance. 
     
     
     TestDocGenerator.Config.Builder() - Constructor for class de.smartics.testdoc.collect.generator. 
     TestDocGenerator.Config.Builder 
     
    
        
     
     
     TestDocMethodExtractor - Class in 
     de.smartics.testdoc.collect.extractor 
     
    
      Extracts unit test doc information from a specified method. 
     
     
     TestDocMethodExtractor(ExtractorConfig, ExecutableElement) - Constructor for class de.smartics.testdoc.collect.extractor. 
     TestDocMethodExtractor 
     
    
      Default constructor. 
     
     
     TestDocProcessor - Class in 
     de.smartics.testdoc.collect.processor 
     
    
      Processes 
     Uut annotations. 
     
     
     TestDocProcessor() - Constructor for class de.smartics.testdoc.collect.processor. 
     TestDocProcessor 
     
    
        
     
     
     TestDocProperty - Enum in 
     de.smartics.testdoc.core 
     
    
      Provides properties for the configuration of the test doc report. 
     
     
     TestDocTypeExtractor - Class in 
     de.smartics.testdoc.collect.extractor 
     
    
      Extracts unit test doc information from a specified type. 
     
     
     TestDocTypeExtractor(ExtractorConfig, TypeElement) - Constructor for class de.smartics.testdoc.collect.extractor. 
     TestDocTypeExtractor 
     
    
      Default constructor. 
     
     
     TestDocVariableExtractor - Class in 
     de.smartics.testdoc.collect.extractor 
     
    
      Extracts unit test doc information from a specified variable. 
     
     
     TestDocVariableExtractor(ExtractorConfig, VariableElement) - Constructor for class de.smartics.testdoc.collect.extractor. 
     TestDocVariableExtractor 
     
    
      Default constructor. 
     
     
     TestMethodDoc - Class in 
     de.smartics.testdoc.core.doc 
     
    
      Provides information about a test method of a scenario. 
     
     
     TestMethodDoc(String, String, SourceCodeLocation, String) - Constructor for class de.smartics.testdoc.core.doc. 
     TestMethodDoc 
     
    
      Default constructor. 
     
     
     TestNameUtils - Interface in 
     de.smartics.testdoc.core.doc.names 
     
    
      Utilities to create displayable names (labels) for tests. 
     
     
     toString() - Method in class de.smartics.testdoc.core.doc. 
     ScenarioTestDoc 
     
    
      Returns the string representation of the object. 
     
     
     toString() - Method in class de.smartics.testdoc.core.doc. 
     SortKey 
     
     
     
     
     toString() - Method in class de.smartics.testdoc.core.doc. 
     TestMethodDoc 
     
    
      Delegates call to 
     StringBuilder.toString(). 
     
     
     toString() - Method in class de.smartics.testdoc.core.doc. 
     Type 
     
    
      Returns the string representation of the object. 
     
     
     toString() - Method in class de.smartics.testdoc.core.doc. 
     UnitTestDoc 
     
    
      Returns the string representation of the object. 
     
     
     toString() - Method in enum de.smartics.testdoc.core. 
     TestDocProperty 
     
    
      Returns the string representation of the object. 
     
     
     Type - Class in 
     de.smartics.testdoc.core.doc 
     
    
      Stores the package and type name of a UUT type name. 
     
     
     Type(String) - Constructor for class de.smartics.testdoc.core.doc. 
     Type 
     
    
      Default constructor. 
     
    
   
  
     U 
    
     
     UnitTestDoc - Class in 
     de.smartics.testdoc.core.doc 
     
    
      The test documentation of a unit under test. 
     
     
     UnitTestDoc(String) - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDoc 
     
    
      Convenience constructor with type name as a 
     String. 
     
     
     UnitTestDoc(Type) - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDoc 
     
    
      Convenience constructor with only a type. 
     
     
     UnitTestDoc(String, ScenarioTestDoc...) - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDoc 
     
    
      Convenience constructor to allow adding a list of scenarios as varargs. 
     
     
     UnitTestDoc(String, List<ScenarioTestDoc>) - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDoc 
     
    
      Convenience constructor to allow adding a list of scenarios with an UUT type name as 
     String. 
     
     
     UnitTestDoc(Type, ScenarioTestDoc...) - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDoc 
     
    
      Convenience constructor to allow adding a list of scenarios as varargs. 
     
     
     UnitTestDoc(Type, List<ScenarioTestDoc>) - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDoc 
     
    
      Default constructor to allow adding a list of scenarios. 
     
     
     UnitTestDocExporter - Interface in 
     de.smartics.testdoc.core.export 
     
    
      Exports the test documentation to a stream. 
     
     
     UnitTestDocIndex - Class in 
     de.smartics.testdoc.core.doc 
     
    
      The index of all collected unit test documentation instances. 
     
     
     UnitTestDocIndex() - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDocIndex 
     
    
      Default constructor. 
     
     
     UnitTestDocIndexExporter - Class in 
     de.smartics.testdoc.core.export 
     
    
      Exports the 
     UnitTestDocIndex to a storage medium. 
     
     
     UnitTestDocIndexExporter(OutputManager) - Constructor for class de.smartics.testdoc.core.export. 
     UnitTestDocIndexExporter 
     
    
      Default constructor. 
     
     
     UnitTestDocNaturalComparator - Class in 
     de.smartics.testdoc.core.doc 
     
    
      Uses the natural order defined by 
     UnitTestDoc. 
     
     
     UnitTestDocNaturalComparator() - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDocNaturalComparator 
     
    
        
     
     
     UnitTestDocTypeSimpleNameComparator - Class in 
     de.smartics.testdoc.core.doc 
     
    
      Compares two instances of 
     UnitTestDoc by the simple name of their 
     Type. 
     
     
     UnitTestDocTypeSimpleNameComparator() - Constructor for class de.smartics.testdoc.core.doc. 
     UnitTestDocTypeSimpleNameComparator 
     
    
        
     
     
     uutExtractor - Variable in class de.smartics.testdoc.collect.extractor. 
     AbstractExtractor 
     
    
      Extracts UUT information. 
     
     
     UutProcess - Class in 
     de.smartics.testdoc.collect.processor 
     
    
      Processes the UUT annotations passed to the annotation processor. 
     
     
     UutProcess(ProcessorLogHelper, ExportAdapter, ExtractorConfig) - Constructor for class de.smartics.testdoc.collect.processor. 
     UutProcess 
     
    
      Default constructor. 
     
    
   
  
     V 
    
     
     valueOf(String) - Static method in enum de.smartics.testdoc.core. 
     TestDocProperty 
     
    
      Returns the enum constant of this type with the specified name. 
     
     
     values() - Static method in enum de.smartics.testdoc.core. 
     TestDocProperty 
     
    
      Returns an array containing the constants of this enum type, in the order they are declared. 
     
    
   
  
     X 
    
     
     XmlExporter - Class in 
     de.smartics.testdoc.core.export 
     
    
      Exports the gathered test documentation to XML. 
     
     
     XmlExporter() - Constructor for class de.smartics.testdoc.core.export. 
     XmlExporter 
     
    
      Convenience constructor with pretty print turned on. 
     
     
     XmlExporter(boolean) - Constructor for class de.smartics.testdoc.core.export. 
     XmlExporter 
     
    
      Default constructor. 
     
    
   
 A B C D E F G H I J L M O P R S T U V X 
     
      
    
     
      
        
         
        
         
          
           Overview  
           Package  
           Class  
           Use  
           Tree  
           Deprecated  
            Index  
           Help  
          
         
       
  
         
      
      
        PREV   NEXT 
       FRAMES    NO FRAMES     
          
      
     
   
  
    
   
 Copyright © 2010-2013 Kronseder & Reiner GmbH - smartics. All Rights Reserved.