Package net.tangly.bdd

Annotation Type Feature

@Target(PACKAGE)
@Retention(RUNTIME)
public @interface Feature
A feature or a story describes a behavior of the build system. You can use a story template or free text to describe the behavior of the system. For each feature a set of scenarios or tests are defined in the form "Given a context When a specific event happens then the expected outcomes are as described". The "Given When Then" scenarios are described in unit tests using the features of JUnit 5 such as test class and nested classes to document and implement the "Given When" and test methods to realize the "Then" part. The display name annotation is used to produce readable and executable behavior driven tests.

  • Required Element Summary

    Required Elements 
    Modifier and Type Required Element Description
    java.lang.String value
    Returns the name of the feature as human readable information for living documentation.

  • Optional Element Summary

    Optional Elements 
    Modifier and Type Optional Element Description
    java.lang.String description
    Returns the detailed description of the story as human readable information for living documentation.
    java.lang.String id
    Returns the identifier of the feature.
    java.lang.String[] tags
    Returns the tags associated with the feature.

  • Element Details

    • value

      java.lang.String value
      Returns the name of the feature as human readable information for living documentation.
      Returns:
      short summary of the feature in a plain human language

    • description

      java.lang.String description
      Returns the detailed description of the story as human readable information for living documentation. One could describe a story in this format: As a {user-defined string}, in order to {user-defined string}, I want to {user-defined string}.
      Returns:
      the story in a plain human language.
      Default:
      ""

    • id

      java.lang.String id
      Returns the identifier of the feature. The identifier can be used for cross-reference and traceability of the requirements.
      Returns:
      identifier of the feature unique in the context of the application domain
      Default:
      ""

    • tags

      java.lang.String[] tags
      Returns the tags associated with the feature. Tags provides domain specific classification and additional information.
      Returns:
      tags defined in the feature
      Default:
      {}