me.zeroeightsix.fiber.api.annotation

Annotation Type Setting

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

Marks a field as a setting. This annotation is optional unless the class has been annotated with @Settings(onlyAnnotated = true)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	comment Sets the comment that will be used for this setting.
boolean	constant Marks a setting as constant or final.
boolean	ignore Marks that this field should be ignored during serialisation.
java.lang.String	name Sets the name that will be used for this setting.

Element Detail

constant

public abstract boolean constant

Marks a setting as constant or final.

Constant settings can not have their value changed after being initialised.

Returns:

whether or not this setting is constant

Default:

false

name

public abstract java.lang.String name

Sets the name that will be used for this setting.

Custom names have a higher authority than naming conventions, and will not be affected by them. If the name is empty, the name of the field being annotated will be used and the naming convention will be applied to that name.

Returns:

An empty string ("") if no custom name was set, or the custom name if one was set.

Default:

""

comment

public abstract java.lang.String comment

Sets the comment that will be used for this setting.

If empty, no comment will be set.

Returns:

An empty string ("") if no comment was set, or the comment if one was set.

Default:

""

ignore

public abstract boolean ignore

Marks that this field should be ignored during serialisation.

Returns:

Whether or not this field should be ignored

Default:

false