com.emarsys.ecommon.prefs.config.declaration
Annotation Type DeclareConfiguration


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

Indicates that the annotated Class declares a Configuration, i.e. there are constants that represent setting names as well as default values and fallback settings.

NOTE that every String constant of such a Class that is not excluded through the public static String[] Field specified by excludedNames() will be treated as a potential ISetting name, default value or fallback declaration.

The retrieval of an actual ConfigurationDeclaration out of a Class annotated with DeclareConfiguration is done by ClassConfigurationDeclaration.

The actual ISettings could be retrieved using a ConfigurationBackend.

Author:
Michael "kULO" Kulovits
See Also:
ClassConfigurationDeclaration, Configuration

Required Element Summary
 java.lang.String name
          The name of the Configuration.
 
Optional Element Summary
 java.lang.String defaultSuffix
          The suffix for String constants that specify default ISettings.
 java.lang.String excludedNames
          The name of the public static String[] Field that defines which fields do net declare ISettings.
 java.lang.String fallbackSuffix
          The suffix for String constants that specify fallback ISettings.
 Configuration.Type type
          The type of the Configuration.
 

Element Detail

name

public abstract java.lang.String name
The name of the Configuration.

Returns:

type

public abstract Configuration.Type type
The type of the Configuration.

Returns:
Default:
com.emarsys.ecommon.prefs.config.Configuration.Type.FALLBACK_DEFAULT

excludedNames

public abstract java.lang.String excludedNames
The name of the public static String[] Field that defines which fields do net declare ISettings.

Returns:
Default:
"EXCLUDED_NAMES"

defaultSuffix

public abstract java.lang.String defaultSuffix
The suffix for String constants that specify default ISettings.

Returns:
Default:
"_DEFAULT"

fallbackSuffix

public abstract java.lang.String fallbackSuffix
The suffix for String constants that specify fallback ISettings.

Returns:
Default:
"_FALLBACK"


Copyright © 2010 emarsys AG. All Rights Reserved.