com.helger.commons.error

Enum ErrorTextProvider.EField

java.lang.Object

java.lang.Enum<ErrorTextProvider.EField>

com.helger.commons.error.ErrorTextProvider.EField

All Implemented Interfaces:

IHasID<String>, Serializable, Comparable<ErrorTextProvider.EField>

Enclosing class:

ErrorTextProvider

public static enum ErrorTextProvider.EField
extends Enum<ErrorTextProvider.EField>
implements IHasID<String>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTANT
ERROR_FIELD_NAME
ERROR_ID
ERROR_LEVEL
ERROR_LINKED_EXCEPTION_CAUSE_CLASS
ERROR_LINKED_EXCEPTION_CAUSE_MESSAGE
ERROR_LINKED_EXCEPTION_CAUSE_STACK_TRACE
ERROR_LINKED_EXCEPTION_CLASS
ERROR_LINKED_EXCEPTION_MESSAGE
ERROR_LINKED_EXCEPTION_STACK_TRACE
ERROR_LOCATION
ERROR_TEXT

Method Summary

Modifier and Type	Method and Description
static ErrorTextProvider.EField	getFromIDOrNull(String sID)
String	getID() Get the unique ID of this object.
boolean	isPlaceholderRequired()
static ErrorTextProvider.EField	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorTextProvider.EField[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Enum Constant Detail

CONSTANT

public static final ErrorTextProvider.EField CONSTANT

ERROR_LEVEL

public static final ErrorTextProvider.EField ERROR_LEVEL

ERROR_ID

public static final ErrorTextProvider.EField ERROR_ID

ERROR_FIELD_NAME

public static final ErrorTextProvider.EField ERROR_FIELD_NAME

ERROR_LOCATION

public static final ErrorTextProvider.EField ERROR_LOCATION

ERROR_TEXT

public static final ErrorTextProvider.EField ERROR_TEXT

ERROR_LINKED_EXCEPTION_CLASS

public static final ErrorTextProvider.EField ERROR_LINKED_EXCEPTION_CLASS

ERROR_LINKED_EXCEPTION_MESSAGE

public static final ErrorTextProvider.EField ERROR_LINKED_EXCEPTION_MESSAGE

ERROR_LINKED_EXCEPTION_STACK_TRACE

public static final ErrorTextProvider.EField ERROR_LINKED_EXCEPTION_STACK_TRACE

ERROR_LINKED_EXCEPTION_CAUSE_CLASS

public static final ErrorTextProvider.EField ERROR_LINKED_EXCEPTION_CAUSE_CLASS

ERROR_LINKED_EXCEPTION_CAUSE_MESSAGE

public static final ErrorTextProvider.EField ERROR_LINKED_EXCEPTION_CAUSE_MESSAGE

ERROR_LINKED_EXCEPTION_CAUSE_STACK_TRACE

public static final ErrorTextProvider.EField ERROR_LINKED_EXCEPTION_CAUSE_STACK_TRACE

Method Detail

values

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

Returns:

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

valueOf

public static ErrorTextProvider.EField 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

getID

@Nonnull
 @Nonempty
public String getID()

Description copied from interface: IHasID

Get the unique ID of this object. If the type is String than the returned value must match an XML NMToken expression (so e.g. no ':' in the ID)!

Specified by:

getID in interface IHasID<String>

Returns:

The ID of this object. May not be null.

isPlaceholderRequired

public boolean isPlaceholderRequired()

getFromIDOrNull

@Nullable
public static ErrorTextProvider.EField getFromIDOrNull(@Nullable
                                                                  String sID)