de.smartics.exceptions.i18n.context
Enum I18nExceptionContextProperty

java.lang.Object
  java.lang.Enum<I18nExceptionContextProperty>
      de.smartics.exceptions.i18n.context.I18nExceptionContextProperty

All Implemented Interfaces:

de.smartics.properties.core.PropertyEnumeration, Serializable, Comparable< I18nExceptionContextProperty>

public enum I18nExceptionContextProperty
     
     

      
      extends 
      
      Enum<
      
      I18nExceptionContextProperty>
     
     
     
     

      
      implements de.smartics.properties.core.PropertyEnumeration
     
     

Provides properties for the configuration of an I18N exception context.

Enum Constant Summary

BUNDLE_PROVIDER_CLASS
The fully qualified class name of an implementation of BundleProvider.

CODE_MESSAGE_FORMATTER_CLASS
Provides the instance of a formatter to format code messages.

MESSAGE_COMPOSER_CLASS
The fully qualified class name of an implementation of MessageComposer.

Method Summary

String	getComponentName()
Object	getDefaultValue() Returns the default value to use if a given property is not specified.
String	getName() Returns the property name.
Class<?>	getType()
de.smartics.properties.core.PropertyValueRange<?>	getValueRange()
boolean	isMandatory()
String	toString() Returns the string representation of the object.
static I18nExceptionContextProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static I18nExceptionContextProperty[]	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

BUNDLE_PROVIDER_CLASS

public static final I18nExceptionContextProperty BUNDLE_PROVIDER_CLASS

The fully qualified class name of an implementation of BundleProvider.

The value of this constant is i18n.bundleProvider.class.

MESSAGE_COMPOSER_CLASS

public static final I18nExceptionContextProperty MESSAGE_COMPOSER_CLASS

The fully qualified class name of an implementation of MessageComposer.

The value of this constant is i18n.messageComposer.class.

CODE_MESSAGE_FORMATTER_CLASS

public static final I18nExceptionContextProperty CODE_MESSAGE_FORMATTER_CLASS

Provides the instance of a formatter to format code messages.

Method Detail

values

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

Returns:

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

valueOf

public static I18nExceptionContextProperty 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

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface de.smartics.properties.core.PropertyEnumeration

getName

public String getName()

Returns the property name.

Specified by:

getName in interface de.smartics.properties.core.PropertyEnumeration

Returns:

the property name.

getType

public Class<?> getType()

Specified by:

getType in interface de.smartics.properties.core.PropertyEnumeration

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface de.smartics.properties.core.PropertyEnumeration

getDefaultValue

public Object getDefaultValue()

Returns the default value to use if a given property is not specified. May be null if no default value is provided.

Specified by:

getDefaultValue in interface de.smartics.properties.core.PropertyEnumeration

Returns:

the default value to use if a given property is not specified.

getValueRange

public de.smartics.properties.core.PropertyValueRange<?> getValueRange()

Specified by:

getValueRange in interface de.smartics.properties.core.PropertyEnumeration

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Enum<I18nExceptionContextProperty>

Returns:

the string representation of the object.