com.netflix.archaius.api.annotations

Annotation Type Configuration

@Documented
@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Configuration

Marks a field as a configuration item. Governator will auto-assign the value based on the #value() of the annotation via the set ConfigurationProvider.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowFields
boolean	allowSetters
java.lang.String	documentation
boolean	immutable
java.lang.String[]	params
java.lang.String	postConfigure
java.lang.String	prefix

Element Detail

prefix

public abstract java.lang.String prefix

Returns:

name/key of the config to assign

Default:

""

params

public abstract java.lang.String[] params

Returns:

field names to use for replacement

Default:

{}

documentation

public abstract java.lang.String documentation

Returns:

user displayable description of this configuration

Default:

""

allowFields

public abstract boolean allowFields

Returns:

true to allow mapping configuration to fields

Default:

false

allowSetters

public abstract boolean allowSetters

Returns:

true to allow mapping configuration to setters

Default:

true

postConfigure

public abstract java.lang.String postConfigure

Returns:

Method to call after configuration is bound

Default:

""

immutable

public abstract boolean immutable

Returns:

If true then properties cannot change once set otherwise methods will be bound to dynamic properties via PropertyFactory.

Default:

false