cz.auderis.tools.config.annotation

Annotation Type ConfigurationEntries

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface ConfigurationEntries

This annotation may be used to mark a class as a container of configuration entry access interface. This indication is not required, i.e. interfaces without any class-level annotation may be used for this purpose as well.

The primary purpose of this annotation is a factoring of common configuration entry name prefix to a single place. If the prefix attribute is an empty string, no prefix will be used. If the prefix is set to CLASS_NAME_PREFIX, the simple class name (without packages) will be used as a prefix.

Example: Given the following interface

      @ConfigurationEntries( prefix = "org.example" )
     public interface TestInterface {
         String textValue();
         int numericValue();
          @ConfigurationEntryName( name = "system.enabled" )
         boolean enabled();
     }
 

the retrieved configuration entries will be:

Access method	Configuration entry
textValue()	org.example.textValue
numericValue()	org.example.numericValue
enabled()	org.example.system.enabled

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Field Summary

Fields

Modifier and Type	Fields and Description
static String	CLASS_NAME_PREFIX

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	prefix

Field Detail

CLASS_NAME_PREFIX

public static final String CLASS_NAME_PREFIX

Element Detail

prefix

public abstract String prefix

Default:

""