com.impossibl.postgres.system

Annotation Type Setting.Info

@Target(value=FIELD)
 @Retention(value=CLASS)
public static @interface Setting.Info

Setting definition annotation. The annotation must be used on a "declared" static final field named inside a setting factory (i.e. a classed annotated with Setting.Factory). A declared setting field is one initialized with Setting.declare() \@Setting.Factory class MySettings { \@Setting.Group.Info(id="a", desc="A group") static final A_GROUP = Setting.Group.declare() \@Setting.Info(name="a.setting", group="a", desc="A Setting", def="10") static final A_SETTING = Setting.declare() }

Field Summary

Fields

Modifier and Type	Fields and Description
static String	NO_DEFAULT

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	desc Description of the setting.
String	group Id of the group to which the setting belongs.
String	name Primary name of the setting.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	alternateNames Alternate names for the setting.
String	def Static default value of the setting.
String	defDynamic Code that will be directly copied and used as a dynamic default value.
String	defStatic Code that will be directly copied and used to provide an initial static default value.
int	max Maximum allowed value for setting.
int	min Minimum allowed value for setting.

Field Detail

NO_DEFAULT

public static final String NO_DEFAULT

Element Detail

name

public abstract String name

Primary name of the setting. Must be in dot-dash format (e.g. this.is.a.setting-name) to ensure it can be translated and used via command line easily.

group

public abstract String group

Id of the group to which the setting belongs.

desc

public abstract String desc

Description of the setting. The text can include simple markup allowable in Markdown and JavaDoc.

def

public abstract String def

Static default value of the setting.

Default:

"$$$NULL$$$"

defDynamic

public abstract String defDynamic

Code that will be directly copied and used as a dynamic default value. When this value is set, def() is treated as a description of the dynamic value and defStatic() is ignored.

See Also:

Setting

Default:

"$$$NULL$$$"

defStatic

public abstract String defStatic

Code that will be directly copied and used to provide an initial static default value. This should be used to initialize a default value with a non-const variable. When this value is set, def() is treated as a description of the dynamic value. If defDynamic() is provided this value is ignored.

See Also:

Setting

Default:

"$$$NULL$$$"

min

public abstract int min

Minimum allowed value for setting. This value is ignored if the setting's type is not an Integer.

See Also:

Setting

Default:

-2147483648

max

public abstract int max

Maximum allowed value for setting. This value is ignored if the setting's type is not an Integer.

See Also:

Setting

Default:

2147483647

alternateNames

public abstract String[] alternateNames

Alternate names for the setting.

See Also:

Setting

Default:

{}