de.smartics.testdoc.core
Enum TestDocProperty

java.lang.Object
  java.lang.Enum<TestDocProperty>
      de.smartics.testdoc.core.TestDocProperty

All Implemented Interfaces:

de.smartics.properties.core.PropertyEnumeration, Serializable, Comparable< TestDocProperty>

public enum TestDocProperty
     
     

      
      extends 
      
      Enum<
      
      TestDocProperty>
     
     
     
     

      
      implements de.smartics.properties.core.PropertyEnumeration
     
     

Provides properties for the configuration of the test doc report.

Author:

Robert Reiner

Enum Constant Summary

EXPORT_ADAPTER_BASE_DIR
The path to the directory to export the test documentation fragments to.

EXPORT_ADAPTER_CLASS_NAME
The name of a class that implements de.smartics.testdoc.report.ExportAdapter to handle unit test documentation found by the annotation processor.

PROC_CONF_QUIET
Allows to control the verboseness of the processor.

TEST_NAME_UTILS_CLASS_NAME
The name of a class that implements de.smartics.testdoc.report.doc.TestNameUtils to handle names found in test cases.

Method Summary

String	getComponentName()
Object	getDefaultValue() Returns the default value to use if a given property is not specified.
String	getName() Returns the property name.
Class<?>	getType()
de.smartics.properties.core.PropertyValueRange<?>	getValueRange()
boolean	isMandatory()
String	toString() Returns the string representation of the object.
static TestDocProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static TestDocProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEST_NAME_UTILS_CLASS_NAME

public static final TestDocProperty TEST_NAME_UTILS_CLASS_NAME

The name of a class that implements de.smartics.testdoc.report.doc.TestNameUtils to handle names found in test cases.

The implementation is required to provide a public no-args constructor.

EXPORT_ADAPTER_CLASS_NAME

public static final TestDocProperty EXPORT_ADAPTER_CLASS_NAME

The name of a class that implements de.smartics.testdoc.report.ExportAdapter to handle unit test documentation found by the annotation processor.

The implementation is required to provide a public no-args constructor.

EXPORT_ADAPTER_BASE_DIR

public static final TestDocProperty EXPORT_ADAPTER_BASE_DIR

The path to the directory to export the test documentation fragments to.

This will neglect the EXPORT_ADAPTER_CLASS_NAME property and select a directory based export adapter.

PROC_CONF_QUIET

public static final TestDocProperty PROC_CONF_QUIET

Allows to control the verboseness of the processor.

If tdoc.processor.quiet is set to true, the processor will be less verbose.

Method Detail

values

public static TestDocProperty[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TestDocProperty c : TestDocProperty.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TestDocProperty valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface de.smartics.properties.core.PropertyEnumeration

See Also:

PropertyEnumeration.getComponentName()

getName

public String getName()

Returns the property name.

Specified by:

getName in interface de.smartics.properties.core.PropertyEnumeration

Returns:

the property name.

getType

public Class<?> getType()

Specified by:

getType in interface de.smartics.properties.core.PropertyEnumeration

See Also:

PropertyEnumeration.getType()

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface de.smartics.properties.core.PropertyEnumeration

See Also:

PropertyEnumeration.isMandatory()

getDefaultValue

public Object getDefaultValue()

Returns the default value to use if a given property is not specified. May be null if no default value is provided.

Specified by:

getDefaultValue in interface de.smartics.properties.core.PropertyEnumeration

Returns:

the default value to use if a given property is not specified.

getValueRange

public de.smartics.properties.core.PropertyValueRange<?> getValueRange()

Specified by:

getValueRange in interface de.smartics.properties.core.PropertyEnumeration

See Also:

PropertyEnumeration.getValueRange()

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Enum<TestDocProperty>

Returns:

the string representation of the object.