fr.opensagres.xdocreport.template.annotations

Annotation Type FieldMetadata

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface FieldMetadata

This annotation should be attached to getter method which is called from Velocity or Freemarker Otherwise it will have no effect

Author:

rcusnir

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Returns the description of the field.
ImageMetadata[]	images Returns the image name if field must use mapping name with image and empty otherwise.
String	syntaxKind Returns the syntax kind to use for the field and empty otherwise.
boolean	syntaxWithDirective Returns true if field which used syntax kind can have template syntax and false otherwise.

Element Detail

syntaxKind

public abstract String syntaxKind

Returns the syntax kind to use for the field and empty otherwise.

Returns:

the syntax kind to use for the field and empty otherwise.

Default:

""

syntaxWithDirective

public abstract boolean syntaxWithDirective

Returns true if field which used syntax kind can have template syntax and false otherwise.

Returns:

true if field which used syntax kind can have template syntax and false otherwise.

Default:

false

description

public abstract String description

Returns the description of the field.

Returns:

the description of the field.

Default:

""

images

public abstract ImageMetadata[] images

Returns the image name if field must use mapping name with image and empty otherwise.

Returns:

the image name if field must use mapping name with image and empty otherwise.

Default:

{}