cz.auderis.tools.config.annotation

Annotation Type ConfigurationEntry

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
public @interface ConfigurationEntry

This method-level annotation is used for specification of explicit configuration entry name. If this annotation is not present, by default the name of the method (with standard property accessor prefixes get and is stripped if present).

The annotation may define optional aliases, if the configuration entry may be known under multiple names.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	alias Declares configuration entry aliases that will be searched if no configuration entry with the primary name is found.
Class<?>	collectionItemType If the type of configuration entry is a collection, it is necessary to determine the legal type of the collection's items.
String	name Declares explicit primary name of the configuration entry.

Element Detail

name

public abstract String name

Declares explicit primary name of the configuration entry.

If the value is empty string or the annotation is not present, the primary name is derived from the method name with optional getter prefix intelligently stripped (prefix "get" is removed only if followed by capital letter), as shown in the following examples:

• getSimpleProperty() is transformed to simpleProperty
• getterOfInt() is not transformed, i.e. the name is getterOfInt

Returns:

explicit name of configuration entry

Default:

""

alias

public abstract String[] alias

Declares configuration entry aliases that will be searched if no configuration entry with the primary name is found.

Returns:

array of configuration entry aliases

Default:

{}

collectionItemType

public abstract Class<?> collectionItemType

If the type of configuration entry is a collection, it is necessary to determine the legal type of the collection's items. Using this attribute the type is established for the purpose of parsing.

Returns:

base type of items in collection class

Default:

java.lang.Void.class