de.smartics.testdoc.annotations
Annotation Type TestDocHint

@Documented
@Inherited
@Target(value={TYPE,FIELD,METHOD,LOCAL_VARIABLE})
@Retention(value=RUNTIME)
public @interface TestDocHint

Add a hint to the interpretation of information provided by a test case.

Author:

Robert Reiner

Optional Element Summary

String	indexSortKey The sort index key.
String	mainSortKey The main sort index key.
String	sentence Allows to exactly specify the sentence that is normally derived from the test case's method name.

sentence

public abstract String sentence

Allows to exactly specify the sentence that is normally derived from the test case's method name. If desired, this can be used as a primitive way to translate a method name to another language.

Instead of deriving the method name, the process will use the so specified sentence verbatim.

If the sentence is blank, the deriving mechanism will be used.

Returns:

the sentence that describes the actual test case (on method level).

Default:

""

mainSortKey

public abstract String mainSortKey

The main sort index key.

If added to a type, the key is passed to each test method in this type.

Returns:

main sort index key.

Default:

""

indexSortKey

public abstract String indexSortKey

The sort index key.

Returns:

main sort index key.

Default:

""