com.tngtech.jgiven.annotation
Annotation Type IsTag

@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface IsTag

Marks an annotation to be used as a tag in JGiven reports. The name and a possible value will be stored. A value can be an array in which case it is either translated into multiple tags, one for each array element, or a comma-separated list of values.

Note that the annotation must have retention policy RUNTIME

Optional Element Summary

String	description An optional description of the tag that will appear in the generated report.
boolean	explodeArray If the annotation has a value and the value is an array, whether or not to explode that array to multiple tags or not.
boolean	ignoreValue Whether values should be ignored.
boolean	prependType Whether the type should be prepended to the tag if the tag has a value.
String	type An optional type description that overrides the default which is the name of the annotation.
String	value An optional default value for the tag.

explodeArray

public abstract boolean explodeArray

If the annotation has a value and the value is an array, whether or not to explode that array to multiple tags or not.

Default:

true

ignoreValue

public abstract boolean ignoreValue

Whether values should be ignored. If true only a single tag is created for the annotation and the value does not appear in the report. This is useful if the value is used as an internal comment

See Also:

NotImplementedYet

Default:

false

value

public abstract String value

An optional default value for the tag.

Default:

""

description

public abstract String description

An optional description of the tag that will appear in the generated report.

Default:

""

type

public abstract String type

An optional type description that overrides the default which is the name of the annotation.

Default:

""

prependType

public abstract boolean prependType

Whether the type should be prepended to the tag if the tag has a value.

Default:

false