net.lenni0451.optconfig.annotations

Annotation Type Description

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

Set a default description for the option.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String[]	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	generator Specify a generator method that will be called to generate the description.

Element Detail

value

public abstract java.lang.String[] value

Returns:

The description of the option

generator

public abstract java.lang.String generator

Specify a generator method that will be called to generate the description.
The generated output will be appended to the description array.
The method must be static, take no parameters and return a string array.
It must be in the same class as the field.

Returns:

The name of the generator method

Default:

""