io.github.fablabsmc.fablabs.api.fiber.v1.annotation

Annotation Type Settings

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

Indicates a type represents a structure in a configuration file.

While it not necessary to use this annotation to generate ConfigTrees from a POJO class, it can be used to specify other metadata.

See Also:

onlyAnnotated()

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends SettingNamingConvention>	namingConvention Deprecated. use AnnotatedSettings.Builder.useNamingConvention(SettingNamingConvention)
boolean	onlyAnnotated Specifies whether or not all fields in this class should be serialised, or only those annotated with Setting.

Element Detail

onlyAnnotated

public abstract boolean onlyAnnotated

Specifies whether or not all fields in this class should be serialised, or only those annotated with Setting.

If you want to exclude one field without having to mark all others with the Setting annotation, the field can be marked as transient instead. All transient fields are ignored by default.

Returns:

whether or not only annotated fields should be serialised

See Also:

AnnotatedSettings.Builder.collectOnlyAnnotatedMembers()

Default:

false

namingConvention

@Deprecated
public abstract Class<? extends SettingNamingConvention> namingConvention

Deprecated. use AnnotatedSettings.Builder.useNamingConvention(SettingNamingConvention)

Returns the naming convention used for (re)naming the fields in this class during serialisation.

Returns:

the naming convention for this class

Default:

io.github.fablabsmc.fablabs.api.fiber.v1.annotation.convention.NoNamingConvention.class