de.smartics.properties.api.config.domain
Enum ConfigurationCode

Package class diagram package ConfigurationCode
java.lang.Object
  extended by java.lang.Enum<ConfigurationCode>
      extended by de.smartics.properties.api.config.domain.ConfigurationCode
All Implemented Interfaces:
de.smartics.exceptions.code.NumberCode, de.smartics.exceptions.core.Code, ConfigurationsCode, PropertiesCode, Serializable, Comparable< ConfigurationCode>

public enum ConfigurationCode
     
     
extends Enum< ConfigurationCode>
implements ConfigurationsCode

Codes dealing with property problems.


Enum Constant Summary
COMPOUND_CONFIGURATION
          The property is not known to the system.
CONFIGURATION_ACCESS_FAILED
          Signals that configuration with the given key cannot be accessed.
CONFIGURATION_LOADING
          Signals that configuration with the given key cannot be loaded.
CONFIGURATION_RESOLVING_FAILED
          Signals that configuration with the given key cannot be accessed.
DUPLICATE_CONFIGURATION
          Signals that a configuration with the given key has already been registered.
DUPLICATE_PROPERTY
          Signals that a property has been encountered twice.
DUPLICATE_PROPERTY_DEFINITION
          Signals that a property descriptor has been encountered twice.
FACTORY_IMPLEMENTATION_NOT_FOUND
          The implementation for a factory type cannot be found.
FACTORY_INSTANTIATION_FAILED
          The factory implementation cannot be instantiated.
INVALID_CONFIGURATION
          Signals that the configuration is invalid or at least properties cannot be validated because there are no properties descriptors registered for them.
INVALID_CONFIGURATION_DUE_TO_CONVERSION_WITH_SOURCE
          Signals that the value does not match the given constraints and provides information about the source location of the culprit.
INVALID_CONFIGURATION_DUE_TO_RESOLVE_WITH_SOURCE
          Signals that the value cannot be resolve and provides information about the source location of the culprit.
INVALID_CONFIGURATION_WITH_SOURCE
          Signals that the value does not match the given constraints and provides information about the source location of the culprit.
MISSING_CONFIGURATION
          Signals that a configuration with the given key cannot be found.
UNKNOWN_PROPERTY
          Signals multiple problems with a configuration.
 
Method Summary
 String getCode()
           
 String getComponentId()
           
 String getDisplayId()
           
 Integer getMajorNumber()
           
 Integer getMinorNumber()
           
 String toString()
          Returns the string representation of the object.
static ConfigurationCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ConfigurationCode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FACTORY_IMPLEMENTATION_NOT_FOUND

@MessageParamsDescriptor(value=TypeProblemMessageBean.class)
public static final ConfigurationCode FACTORY_IMPLEMENTATION_NOT_FOUND
The implementation for a factory type cannot be found.


FACTORY_INSTANTIATION_FAILED

@MessageParamsDescriptor(value=TypeProblemMessageBean.class)
public static final ConfigurationCode FACTORY_INSTANTIATION_FAILED
The factory implementation cannot be instantiated.


COMPOUND_CONFIGURATION

@MessageParamsDescriptor(value=CompoundConfigurationException.class)
public static final ConfigurationCode COMPOUND_CONFIGURATION
The property is not known to the system.


CONFIGURATION_LOADING

@MessageParamsDescriptor(value=ConfigurationLoadingException.class)
public static final ConfigurationCode CONFIGURATION_LOADING
Signals that configuration with the given key cannot be loaded.


CONFIGURATION_ACCESS_FAILED

@MessageParamsDescriptor(value=ConfigurationLoadingException.class)
public static final ConfigurationCode CONFIGURATION_ACCESS_FAILED
Signals that configuration with the given key cannot be accessed.


CONFIGURATION_RESOLVING_FAILED

@MessageParamsDescriptor(value=ResolveConfigurationException.class)
public static final ConfigurationCode CONFIGURATION_RESOLVING_FAILED
Signals that configuration with the given key cannot be accessed.


DUPLICATE_CONFIGURATION

@MessageParamsDescriptor(value=DuplicateConfigurationException.class)
public static final ConfigurationCode DUPLICATE_CONFIGURATION
Signals that a configuration with the given key has already been registered.


INVALID_CONFIGURATION

@MessageParamsDescriptor(value=ConfigurationValidationException.class)
public static final ConfigurationCode INVALID_CONFIGURATION
Signals that the configuration is invalid or at least properties cannot be validated because there are no properties descriptors registered for them.


DUPLICATE_PROPERTY_DEFINITION

@MessageParamsDescriptor(value=DuplicatePropertyDefinitionException.class)
public static final ConfigurationCode DUPLICATE_PROPERTY_DEFINITION
Signals that a property descriptor has been encountered twice.


DUPLICATE_PROPERTY

@MessageParamsDescriptor(value=DuplicatePropertyException.class)
public static final ConfigurationCode DUPLICATE_PROPERTY
Signals that a property has been encountered twice.


MISSING_CONFIGURATION

@MessageParamsDescriptor(value=MissingConfigurationException.class)
public static final ConfigurationCode MISSING_CONFIGURATION
Signals that a configuration with the given key cannot be found.


INVALID_CONFIGURATION_WITH_SOURCE

@MessageParamsDescriptor(value=PropertyValidationWithSourceMessageBean.class)
public static final ConfigurationCode INVALID_CONFIGURATION_WITH_SOURCE
Signals that the value does not match the given constraints and provides information about the source location of the culprit.


INVALID_CONFIGURATION_DUE_TO_CONVERSION_WITH_SOURCE

@MessageParamsDescriptor(value=PropertyValueWithSourceMessageBean.class)
public static final ConfigurationCode INVALID_CONFIGURATION_DUE_TO_CONVERSION_WITH_SOURCE
Signals that the value does not match the given constraints and provides information about the source location of the culprit.


INVALID_CONFIGURATION_DUE_TO_RESOLVE_WITH_SOURCE

@MessageParamsDescriptor(value=PropertyExpressionWithSourceMessageBean.class)
public static final ConfigurationCode INVALID_CONFIGURATION_DUE_TO_RESOLVE_WITH_SOURCE
Signals that the value cannot be resolve and provides information about the source location of the culprit. Therefore the expression contains unresolved placeholders.


UNKNOWN_PROPERTY

@MessageParamsDescriptor(value=UnknownPropertyException.class)
public static final ConfigurationCode UNKNOWN_PROPERTY
Signals multiple problems with a configuration.

Method Detail

values

public static ConfigurationCode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ConfigurationCode c : ConfigurationCode.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConfigurationCode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getCode

public String getCode()
Specified by:
getCode in interface de.smartics.exceptions.core.Code

getComponentId

public String getComponentId()
Specified by:
getComponentId in interface de.smartics.exceptions.core.Code

getDisplayId

public String getDisplayId()
Specified by:
getDisplayId in interface de.smartics.exceptions.core.Code

getMajorNumber

public Integer getMajorNumber()
Specified by:
getMajorNumber in interface de.smartics.exceptions.code.NumberCode

getMinorNumber

public Integer getMinorNumber()
Specified by:
getMinorNumber in interface de.smartics.exceptions.code.NumberCode

toString

public String toString()
Returns the string representation of the object.

Specified by:
toString in interface de.smartics.exceptions.core.Code
Overrides:
toString in class Enum<ConfigurationCode>
Returns:
the string representation of the object.


Copyright © 2012-2013 Kronseder & Reiner GmbH - smartics. All Rights Reserved.