Package space.arim.dazzleconf.annote

package space.arim.dazzleconf.annote

Defines annotations which control the behaviour of configuration entries.

The most common annotations used will be entry attributes: ConfKey, ConfComments, and annotations in ConfDefault all describe a property of a configuration entry. SubSection defines a config entry as a nested configuration section.

Next are validators. NumericRange and IntegerRange specify the range of a numeric type, while CollectionSize controls the size of some collection. For finer grained validation, ConfValidator may be specified.

There are only 2 annotations applying to a configuration interface rather than individual entries: ConfHeader and ConfSerialisers. The former adds a comment header, and the latter attaches additional ValueSerialiser implementations used specifically for the target configuration interface.

Class Summary

Class	Description
ConfDefault	Container for annotations used to specify the default value on a config entry.

Annotation Types Summary

Annotation Type	Description
CollectionSize	Applied to lists, sets, collections, and maps in order to limit their size
ConfComments	Inserts one or more comments ahead of the config entry this annotation is placed before
ConfDefault.DefaultBoolean	Specifies the default value as a boolean
ConfDefault.DefaultBooleans	Specifies the default value as a boolean array.
ConfDefault.DefaultDouble	Specifies the default value as a double.
ConfDefault.DefaultDoubles	Specifies the default value as a double array.
ConfDefault.DefaultInteger	Specifies the default value as an integer.
ConfDefault.DefaultIntegers	Specifies the default value as an integer array.
ConfDefault.DefaultLong	Specifies the default value as a long.
ConfDefault.DefaultLongs	Specifies the default value as a long array.
ConfDefault.DefaultMap	Specifies the default value as a map.
ConfDefault.DefaultObject	Specifies the qualified name of the static method returning the default value.
ConfDefault.DefaultString	Specifies the default value as string.
ConfDefault.DefaultStrings	Specifies the default value as a string array.
ConfHeader	Allows specifying the comment header on a top level configuration or a comment on a sub section.
ConfKey	Specifies the key whose value will be used for this method.
ConfSerialisers	Attaches a value serialiser to a configuration interface
ConfValidator	Attaches a value validator to a config entry
IntegerRange	Controls the range of an numeric type.
NumericRange	Controls the range of any numeric type.
SubSection	Specifies either that the config entry is a configuration section, or that a generic parameter of a collection (a collection element or map value) is a configuration section.