com.tngtech.jgiven.annotation
Class DefaultTagDescriptionGenerator

java.lang.Object
  com.tngtech.jgiven.annotation.DefaultTagDescriptionGenerator

All Implemented Interfaces:

TagDescriptionGenerator

public class DefaultTagDescriptionGenerator
extends java.lang.Object
implements TagDescriptionGenerator

A default implementation of TagDescriptionGenerator. It just calls tagConfiguration.getDescription().

Since:

0.6.3

Constructor Summary

DefaultTagDescriptionGenerator()

Method Summary

java.lang.String

generateDescription(TagConfiguration tagConfiguration, java.lang.annotation.Annotation annotation, java.lang.Object value) Implement this method to generate the description for the given annotation and its value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTagDescriptionGenerator

public DefaultTagDescriptionGenerator()

Method Detail

generateDescription

public java.lang.String generateDescription(TagConfiguration tagConfiguration,
                                            java.lang.annotation.Annotation annotation,
                                            java.lang.Object value)

Description copied from interface: TagDescriptionGenerator

Implement this method to generate the description for the given annotation and its value.

Note that when the value of the annotation is an array and IsTag.explodeArray() is true, then this method is called for each value of the array and not once for the whole array. Otherwise it is called only once.

Specified by:

generateDescription in interface TagDescriptionGenerator

Parameters:

tagConfiguration - the configuration of the tag. The values typically correspond to the annotation. However, it is also possible to configure annotations to be tags using JGivenConfiguration, in which case there is no IsTag annotation.

annotation - the actual annotation that was used as a tag

value - the value of the annotation. If the annotation has no value the default value is passed (IsTag.value()

Returns:

the description of the annotation for the given value