com.netflix.governator.annotations

Annotation Type Configuration

@Documented
@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
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 com.netflix.governator.configurationConfigurationProvider.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	documentation
boolean	ignoreTypeMismatch If the value of the property defined for this config is not the same or can not be converted to the required type, setting this to true will ignore such a value.

Element Detail

value

public abstract java.lang.String value

Returns:

name/key of the config to assign

documentation

public abstract java.lang.String documentation

Returns:

user displayable description of this configuration

Default:

""

ignoreTypeMismatch

public abstract boolean ignoreTypeMismatch

If the value of the property defined for this config is not the same or can not be converted to the required type, setting this to true will ignore such a value. In such a case, the target field will contain the default value if defined.
The error during configuration is deemed as a type mismatch if the exception thrown by the com.netflix.governator.configurationConfigurationProvider is one amongst:

• IllegalArgumentException
• org.apache.commons.configuration.ConversionException

Returns:

true if type mismatch must be ignored. false otherwise. Default value is false

Default:

false