Annotation Interface ConfigurationReader

@Documented
@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
@BeanProperties(accessKind={METHOD,FIELD},
                visibility=DEFAULT)
public @interface ConfigurationReader

A meta annotation for use with other annotations to indicate that the annotation reads configuration.

Since:

1.0

Author:

Graeme Rocher

See Also:

• ConfigurationProperties

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_PREFIX	The base prefix name.
static final String	PREFIX	The prefix name.
static final String	PREFIX_CALCULATED

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	basePrefix	The base prefix to prepend to the original prefix.
String[]	excludes
String[]	includes
String	prefix
String	value	The prefix to use when resolving properties.

Field Details

PREFIX

static final String PREFIX

The prefix name.

See Also:

• Constant Field Values

BASE_PREFIX

static final String BASE_PREFIX

The base prefix name.

See Also:

• Constant Field Values

PREFIX_CALCULATED

static final String PREFIX_CALCULATED

See Also:

• Constant Field Values

Element Details

value

@AliasFor(member="prefix")
String value

The prefix to use when resolving properties. The prefix should be defined in kebab case. Example: my-app.foo.

Returns:

The configuration entry to read

Default:

""

prefix

String prefix

Returns:

The prefix to use

Default:

""

basePrefix

String basePrefix

The base prefix to prepend to the original prefix.

Returns:

The base prefix

Since:

4.0.0

Default:

""

includes

@AliasFor(annotation=BeanProperties.class,
          member="includes")
String[] includes

Returns:

The names of the properties to include

Default:

{}

excludes

@AliasFor(annotation=BeanProperties.class,
          member="excludes")
String[] excludes

Returns:

The names of the properties to exclude

Default:

{}