net.lenni0451.optconfig.annotations

Annotation Type OptConfig

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

Mark a class as an OptConfig class.
This annotation is required to use the OptConfig API.

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	CONFIG_VERSION_OPTION
static int	DEFAULT_VERSION

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	header Get the header of the configuration file.
int	version Get the version of the configuration.

Field Detail

DEFAULT_VERSION

public static final int DEFAULT_VERSION

CONFIG_VERSION_OPTION

public static final java.lang.String CONFIG_VERSION_OPTION

Element Detail

version

public abstract int version

Get the version of the configuration.
If a version mismatch is detected, the migrator will be called. If no migrator is set, the default values will be used for new options and old options will be removed.

Returns:

The version of the configuration

Default:

1

header

public abstract java.lang.String[] header

Get the header of the configuration file.
This header will be written at the top of the configuration file.
A new line will be added automatically below the header.

Returns:

The header of the configuration file

Default:

{}