nova.core.config

Annotation Type Config

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

This annotation is used to fetch and load configs easily. Configs are saved in HOCON (Human-Optimized Config Object Notation) format, which is a nice JSON superset with less pedantic syntax and comments. It has a tree structure, so any element could be reached via package-like path.

Example usage:

 @Config("items.rocket.params")
 public int maxCount = 3; //4 is the default value
 

This code will load the items.rocket.params.maxCount config setting into this variable.

The config file content may look like this:

 items{
     rocket{
         params{
             maxCount = 14
             enabled: true
         }
     }
 }
 baz = string
 

For root values you could just use @Config annotation with no parameters:

 @Config
 public String baz = "default";
 

Note, that your class must have an ConfigHolder annotation for this to work properly.

Also, if you allow @ConfigHolder annotation to scan inner @ConfigHolder types, then this types could represent HOCON objects of your config.

See Also:

ConfigHolder

Field Summary

Fields

Modifier and Type	Fields and Description
static Config	DEFAULT

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	comment This comment message will be added to the config file if this field do not yet exist
java.lang.String	value

Field Detail

DEFAULT

public static final Config DEFAULT

Element Detail

value

public abstract java.lang.String value

Returns:

Path to the parent object of this field.

Default:

""

comment

public abstract java.lang.String comment

This comment message will be added to the config file if this field do not yet exist

Returns:

Default comment message.

Default:

""