com.emarsys.ecommon.prefs.config.declaration
Class GenericConfigurationDeclaration

java.lang.Object
  extended by com.emarsys.ecommon.prefs.config.declaration.GenericConfigurationDeclaration
All Implemented Interfaces:
ConfigurationDeclaration
Direct Known Subclasses:
ClassConfigurationDeclaration

public class GenericConfigurationDeclaration
extends java.lang.Object
implements ConfigurationDeclaration

A generic, mutable implementation of ConfigurationDeclaration.

Author:
Michael "kULO" Kulovits

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.emarsys.ecommon.prefs.config.ConfigurationDeclaration
ConfigurationDeclaration.DeclarationType
 
Field Summary
protected  ConfigurationBackend defaults
           
protected  java.util.Map<java.lang.String,java.lang.String> fallbacks
           
protected  java.lang.String name
           
protected  java.util.Set<java.lang.String> settingNames
           
protected  Configuration.Type type
           
 
Constructor Summary
GenericConfigurationDeclaration()
           
GenericConfigurationDeclaration(ConfigurationDeclaration declaration)
           
GenericConfigurationDeclaration(java.lang.String name, Configuration.Type type)
           
 
Method Summary
 ConfigurationBackend getDefaults()
          Returns a ConfigurationBackend that holds all default values defined in this ConfigurationDeclaration, if no such default values are defined an emtpy ConfigurationBackend will be returned.
 java.util.Map<java.lang.String,java.lang.String> getFallbacks()
          Returns the fallback ISettings defined by this ConfigurationDeclaration, if no such fallbacks are present an emtpy Map will be returned.
 java.lang.String getName()
          Returns the name of the Configuration associated with this ConfigurationDeclaration.
 java.util.Set<java.lang.String> getSettingNames()
          Returns a List of declared ISetting names.
 Configuration.Type getType()
          Returns the ConfigurationDeclaration.DeclarationType of the Configuration associated with this ConfigurationDeclaration.
 void setDefaultValue(java.lang.String name, java.lang.String defaultVal)
           
 void setFallback(java.lang.String name, java.lang.String fallback)
           
 void setName(java.lang.String name)
           
 void setType(Configuration.Type type)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

type

protected Configuration.Type type

settingNames

protected final java.util.Set<java.lang.String> settingNames

defaults

protected final ConfigurationBackend defaults

fallbacks

protected final java.util.Map<java.lang.String,java.lang.String> fallbacks
Constructor Detail

GenericConfigurationDeclaration

public GenericConfigurationDeclaration()

GenericConfigurationDeclaration

public GenericConfigurationDeclaration(java.lang.String name,
                                       Configuration.Type type)
Parameters:
name -
type -

GenericConfigurationDeclaration

public GenericConfigurationDeclaration(ConfigurationDeclaration declaration)
Method Detail

getName

public java.lang.String getName()
Description copied from interface: ConfigurationDeclaration
Returns the name of the Configuration associated with this ConfigurationDeclaration.

Specified by:
getName in interface ConfigurationDeclaration
Returns:
always a valid non-null, non-emtpy String.
See Also:
ConfigurationDeclaration.getName()

getType

public Configuration.Type getType()
Description copied from interface: ConfigurationDeclaration
Returns the ConfigurationDeclaration.DeclarationType of the Configuration associated with this ConfigurationDeclaration.

Specified by:
getType in interface ConfigurationDeclaration
Returns:
always a valid ConfigurationDeclaration.DeclarationType, never null.
See Also:
ConfigurationDeclaration.getType()

getSettingNames

public java.util.Set<java.lang.String> getSettingNames()
Description copied from interface: ConfigurationDeclaration
Returns a List of declared ISetting names.

Specified by:
getSettingNames in interface ConfigurationDeclaration
Returns:
always a valid, possibly emtpy, List of ISetting names.
See Also:
ConfigurationDeclaration.getSettingNames()

getFallbacks

public java.util.Map<java.lang.String,java.lang.String> getFallbacks()
Description copied from interface: ConfigurationDeclaration
Returns the fallback ISettings defined by this ConfigurationDeclaration, if no such fallbacks are present an emtpy Map will be returned.

Specified by:
getFallbacks in interface ConfigurationDeclaration
Returns:
always a valid Map instance, never null.
See Also:
ConfigurationDeclaration.getFallbacks()

getDefaults

public ConfigurationBackend getDefaults()
Description copied from interface: ConfigurationDeclaration
Returns a ConfigurationBackend that holds all default values defined in this ConfigurationDeclaration, if no such default values are defined an emtpy ConfigurationBackend will be returned.

Specified by:
getDefaults in interface ConfigurationDeclaration
Returns:
always a valid ConfigurationBackend instance, never null.
See Also:
ConfigurationDeclaration.getDefaults()

setName

public void setName(java.lang.String name)
Parameters:
name - the name to set

setType

public void setType(Configuration.Type type)
Parameters:
type - the type to set

setDefaultValue

public void setDefaultValue(java.lang.String name,
                            java.lang.String defaultVal)
Parameters:
name -
defaultVal -

setFallback

public void setFallback(java.lang.String name,
                        java.lang.String fallback)
Parameters:
name -
fallback -


Copyright © 2010 emarsys AG. All Rights Reserved.