net.lenni0451.optconfig.annotations

Annotation Type Section

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface Section

Mark a class as a config section.
If this annotation is missing, sections will be serialized using the default object serialization.

Sections can also be used without a field in the config class (independent). name() has to be set in this case.
Independent sections must be an inner class of the config class and are always added to the end of the config file.
Independent section are only supported in static config classes.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	description Get the independent description of the section.
java.lang.String	name Get the independent name of the section.
boolean	reloadable Get the independent reloadable state of the section.

Element Detail

name

public abstract java.lang.String name

Get the independent name of the section.
If this is set, the section has to be an inner class of the config class.
A field for this section must not be present in the config class.

Returns:

The name of the section

Default:

""

description

public abstract java.lang.String[] description

Get the independent description of the section.
If this is set, name() must be set as well.
A field for this section must not be present in the config class.

Returns:

The description of the section

Default:

{}

reloadable

public abstract boolean reloadable

Get the independent reloadable state of the section.
If this is set, name() must be set as well.
A field for this section must not be present in the config class.

Returns:

The reloadable state of the section

Default:

true