Package de.gebit.integrity.fixtures

Annotation Type FixtureMethod.I18NDescription

  • public static @interface FixtureMethod.I18NDescription
    A sub-description that is to be used for a particular language.
    Author:
    Rene Schneider - initial API and implementation

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String locale
      The locale for which this particular description is relevant.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      The description for the method.
      java.lang.String descriptionCall
      The description for the method, to be used if the method is included via 'calldef'.
      java.lang.String descriptionTest
      The description for the method, to be used if the method is included via 'testdef'.

    • Element Detail

      • locale

        java.lang.String locale
        The locale for which this particular description is relevant.
        Returns:

      • description

        java.lang.String description
        The description for the method. This text is intended to be a human-readable description of "what the fixture does". It is highly suggested to provide such a description, since it's one of the main mechanisms used by Integrity to create human-readable test results.

        You may use placeholder values in the description string enclosed in dollar signs, like this: $parameter$. These will be replaced by the matching parameter values at runtime.
        Placeholders can also be conditional (printed only when a parameter is provided or not) like this:
        {parameter?...and $parameter$} - this whole block would not appear if "parameter" is not provided, but if it is, it would be replaced by the text "...and [value of parameter]". By specifying a ^ in front of the parameter name the meaning is reversed: the block will appear if the parameter is NOT specified ({^parameter?not specified}).

        For fixture methods which are suitable in both 'call' and 'test' scenarios, you can define separate description texts via descriptionCall() and descriptionTest(). If such a specific text is defined, it does automatically override this generic description text.
        Returns:
        Default:
        ""

      • descriptionTest

        java.lang.String descriptionTest
        The description for the method, to be used if the method is included via 'testdef'.
        Returns:
        See Also:
        description()
        Default:
        ""

      • descriptionCall

        java.lang.String descriptionCall
        The description for the method, to be used if the method is included via 'calldef'.
        Returns:
        See Also:
        description()
        Default:
        ""