de.smartics.exceptions.context
Enum ExceptionContextProperty

java.lang.Object
  java.lang.Enum<ExceptionContextProperty>
      de.smartics.exceptions.context.ExceptionContextProperty

All Implemented Interfaces:

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

public enum ExceptionContextProperty
     
     

      
      extends 
      
      Enum<
      
      ExceptionContextProperty>
     
     
     
     

      
      implements de.smartics.properties.core.PropertyEnumeration
     
     

Provides properties for the configuration of an exception context.

Author:

Robert Reiner

Enum Constant Summary

EXCEPTION_THROWABLE_HANDLE_MODE
The identifier to select the mode how exceptions are handled for truncation.

ID_FACTORY_CLASS
The fully qualified class name of an implementation of IdFactory.

Method Summary

String	getComponentName() Returns the name of the component the property belongs to.
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 ExceptionContextProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExceptionContextProperty[]	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

ID_FACTORY_CLASS

public static final ExceptionContextProperty ID_FACTORY_CLASS

The fully qualified class name of an implementation of IdFactory.

The value of this constant is id.factory.class.

EXCEPTION_THROWABLE_HANDLE_MODE

public static final ExceptionContextProperty EXCEPTION_THROWABLE_HANDLE_MODE

The identifier to select the mode how exceptions are handled for truncation. Choose one of the enumerated names found in ThrowableHandleMode.

The value of this constant is exception.throwableHandleMode.

Method Detail

values

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

Returns:

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

valueOf

public static ExceptionContextProperty 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()

Returns the name of the component the property belongs to.

This value must not be null.

Specified by:

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

Returns:

the name of the component the property belongs to.

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

See Also:

PropertyEnumeration.getType()

isMandatory

public boolean isMandatory()

Specified by:

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

See Also:

PropertyEnumeration.isMandatory()

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

See Also:

PropertyEnumeration.getValueRange()

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Enum<ExceptionContextProperty>

Returns:

the string representation of the object.