org.jconfigurations

Annotation Type Configuration

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

Marks a field as configurable.

Author:

George Aristy

See Also:

JConfigurator.configure(java.util.Map, java.lang.Object)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends ConfigurationConverter<?>>	converter Specifies the converter to use to set this configuration's value. If none is specified, then a default converter is used from org.jconfigurations.converters. If no default converter then a ConfigurationException will be thrown.
String	name The configuration's name as expected in the configuration source. By default, the name for a given configuration parameter is the field's own name as declared in the source code. Eg.:
boolean	required false by default, a configuration marked as required will trigger an error if it's not found in the input source of configuratios according to its name.

Element Detail

name

public abstract String name

The configuration's name as expected in the configuration source.
By default, the name for a given configuration parameter is the field's own name as declared in the source code.
Eg.:

  @Configuration
 private String name;
 

... will be assigned the value of a configuration property named name, while:

  @Configuration(name = "webServer.name")
 private String name;
 

... will listen for a configuration property named webServer.name.

Returns:

Default:

""

required

public abstract boolean required

false by default, a configuration marked as required will trigger an error if it's not found in the input source of configuratios according to its name.

Returns:

Default:

false

converter

public abstract Class<? extends ConfigurationConverter<?>> converter

Specifies the converter to use to set this configuration's value.
If none is specified, then a default converter is used from org.jconfigurations.converters.
If no default converter then a ConfigurationException will be thrown.

Returns:

See Also:

JConfigurator.configure(java.util.Map, java.lang.Object)

Default:

org.jconfigurations.converters.NoConfigurationConverter.class