Package com.tngtech.jgiven.annotation

Annotation Interface POJOFormat

@Documented @AnnotationFormat(POJOAnnotationFormatter.class) @Retention(RUNTIME) @Target({PARAMETER,ANNOTATION_TYPE}) public @interface POJOFormat
A special format annotation to format POJOs
Since:
0.15.0

  • Element Details

    • excludeFields

      String[] excludeFields
      Specifies which fields should be excluded in the report.

      If includeFields() is set, then this attribute has no effect

      Default:
      {}

    • includeFields

      String[] includeFields
      Specifies which fields should be included in the report. All fields not in this list will be excluded.

      Default:
      {}

    • includeNullColumns

      boolean includeNullColumns
      Whether or not columns with only null values are shown or not. Default is to not show them.
      Default:
      false

    • prefixWithFieldName

      boolean prefixWithFieldName
      When set to true, each formatted field value is prefixed by its field name
      Default:
      false

    • fieldSeparator

      String fieldSeparator
      Specify a field separator
      Default:
      ","

    • brackets

      POJOFormat.BracketsEnum brackets
      Specify the opening/closing brackets pair to set POJO string representation apart of its parent (step) string representation.

      Default brackets pair is POJOFormat.BracketsEnum.SQUARE.
      When no brackets is needed, consider specify POJOFormat.BracketsEnum.NONE

      Default:
      SQUARE

    • fieldFormatsAnnotation

      Class<? extends Annotation> fieldFormatsAnnotation
      Specify a custom NamedFormats annotation

      The NamedFormat defined in this set will be used when formatting POJOs fields.

      Default:
      java.lang.annotation.Annotation.class

    • fieldFormats

      NamedFormat[] fieldFormats
      Specify an array of NamedFormat to use when formatting POJOs fields.

      When a NamedFormat.name() matches a field name, field value is formatted using this NamedFormat.

      Note: when set, has precedence over fieldFormatsAnnotation()

      Default:
      {}