ch.jalu.configme

Annotation Type Comment

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Comment

Comment for properties which are also included in the configuration file upon saving. This annotation can be used on Property fields, as well as on the fields of bean classes that are used for bean properties.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	value Defines the comment to associate with a property field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	repeat Defines if the comment should be repeated, or if it should only be included in the output the first time.

Element Detail

value

public abstract String[] value

Defines the comment to associate with a property field. You can define an empty line with no comment marker ('#' in YAML) by adding a line that is just "\n", e.g. @Comment("Title", "\n", "Lorem ipsum").

Returns:

the comment to associate with the property

repeat

public abstract boolean repeat

Defines if the comment should be repeated, or if it should only be included in the output the first time. This method is relevant only for bean properties: if a bean class used in a collection has comments, the comments will either be included on the first entry if false, or on each entry if true.

Returns:

whether the comment should be repeated for each occurrence of the same field

Default:

false