com.tngtech.jgiven.annotation

Annotation Type POJOFormat

@Documented
 @AnnotationFormat(value=POJOAnnotationFormatter.class)
 @Retention(value=RUNTIME)
 @Target(value={PARAMETER,ANNOTATION_TYPE})
public @interface POJOFormat

A special format annotation to format POJOs

Since:

0.15.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
POJOFormat.BracketsEnum	brackets Specify the opening/closing brackets pair to set POJO string representation apart of its parent (step) string representation.
java.lang.String[]	excludeFields Specifies which fields should be excluded in the report.
NamedFormat[]	fieldFormats Specify an array of NamedFormat to use when formatting POJOs fields.
java.lang.Class<? extends java.lang.annotation.Annotation>	fieldFormatsAnnotation Specify a custom NamedFormats annotation
java.lang.String	fieldSeparator Specify a field separator
java.lang.String[]	includeFields Specifies which fields should be included in the report.
boolean	includeNullColumns Whether or not columns with only null values are shown or not.
boolean	prefixWithFieldName When set to true, each formatted field value is prefixed by its field name

Element Detail

excludeFields

public abstract java.lang.String[] excludeFields

Specifies which fields should be excluded in the report.

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

Default:

{}

includeFields

public abstract java.lang.String[] includeFields

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

Default:

{}

includeNullColumns

public abstract boolean includeNullColumns

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

Default:

false

prefixWithFieldName

public abstract boolean prefixWithFieldName

When set to true, each formatted field value is prefixed by its field name

Default:

false

fieldSeparator

public abstract java.lang.String fieldSeparator

Specify a field separator

Default:

","

brackets

public abstract 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:

com.tngtech.jgiven.annotation.POJOFormat.BracketsEnum.SQUARE

fieldFormatsAnnotation

public abstract java.lang.Class<? extends java.lang.annotation.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

public abstract 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:

{}