de.smartics.properties.api.core.domain
Enum ConfigCode

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

public enum ConfigCode
     
     
extends Enum< ConfigCode>
implements PropertiesCode

Codes dealing with property problems.


Enum Constant Summary
CONFIG_FILE_CANNOT_BE_READ
          Signals that a configuration file cannot be read.
CONFIG_FILE_NOT_FOUND
          Signals that a configuration file cannot be found.
DUPLICATE_DEFAULT_KEY
          Signals that a configuration key within a definitions configuration file is declared as default key twice.
WRONG_NAMESPACE
          Signals that the parser cannot parse the given definitions file since the namespace is not as expected.
 
Method Summary
 String getCode()
           
 String getComponentId()
           
 String getDisplayId()
           
 Integer getMajorNumber()
           
 Integer getMinorNumber()
           
 String toString()
          Returns the string representation of the object.
static ConfigCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ConfigCode[] 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

CONFIG_FILE_NOT_FOUND

@MessageParamsDescriptor(value=ConfigMessageBean.class)
public static final ConfigCode CONFIG_FILE_NOT_FOUND
Signals that a configuration file cannot be found.


CONFIG_FILE_CANNOT_BE_READ

@MessageParamsDescriptor(value=ConfigMessageBean.class)
public static final ConfigCode CONFIG_FILE_CANNOT_BE_READ
Signals that a configuration file cannot be read.


WRONG_NAMESPACE

@MessageParamsDescriptor(value=ConfigMessageBean.class)
public static final ConfigCode WRONG_NAMESPACE
Signals that the parser cannot parse the given definitions file since the namespace is not as expected.


DUPLICATE_DEFAULT_KEY

@MessageParamsDescriptor(value=ConfigMessageBean.class)
public static final ConfigCode DUPLICATE_DEFAULT_KEY
Signals that a configuration key within a definitions configuration file is declared as default key twice.

Method Detail

values

public static ConfigCode[] 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 (ConfigCode c : ConfigCode.values())
    System.out.println(c);

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

valueOf

public static ConfigCode 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<ConfigCode>
Returns:
the string representation of the object.


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