com.helger.commons.error

Enum EErrorLevel

java.lang.Object

java.lang.Enum<EErrorLevel>

com.helger.commons.error.EErrorLevel

All Implemented Interfaces:

IErrorLevel, ISeverityComparable<IErrorLevel>, IHasID<String>, IErrorIndicator, ISuccessIndicator, Serializable, Comparable<EErrorLevel>

public enum EErrorLevel
extends Enum<EErrorLevel>
implements IErrorLevel

Represents a generic error level.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Error level
FATAL_ERROR Fatal error
INFO Information level
SUCCESS Success
WARN Warning level.

Field Summary

Fields

Modifier and Type	Field and Description
static EErrorLevel	HIGHEST Highest error level within this enum
static EErrorLevel	LOWEST Lowest error level within this enum

Method Summary

Methods

Modifier and Type	Method and Description
static EErrorLevel	getFromIDCaseInsensitiveOrDefault(String sID, EErrorLevel eDefault)
static EErrorLevel	getFromIDCaseInsensitiveOrNull(String sID)
static EErrorLevel	getFromIDCaseInsensitiveOrThrow(String sID)
static EErrorLevel	getFromIDOrDefault(String sID, EErrorLevel eDefault)
static EErrorLevel	getFromIDOrNull(String sID)
static EErrorLevel	getFromIDOrThrow(String sID)
String	getID() Get the unique ID of this object.
static IErrorLevel	getMostSevere(IErrorLevel eLevel1, IErrorLevel eLevel2)
int	getNumericLevel()
boolean	isEqualSevereThan(IErrorLevel aErrorLevel) Check if this object is of the same level (= equal important) than the passed object.
boolean	isError()
boolean	isFailure()
boolean	isLessOrEqualSevereThan(IErrorLevel aErrorLevel) Check if this object is of equal or lower level (= equally or less important) than the passed object.
boolean	isLessSevereThan(IErrorLevel aErrorLevel) Check if this object is of lower level (= less important) than the passed object.
boolean	isMoreOrEqualSevereThan(IErrorLevel aErrorLevel) Check if this object is of equal or higher level (= equally or more important) than the passed object.
boolean	isMoreSevereThan(IErrorLevel aErrorLevel) Check if this object is of higher level (= more important) than the passed object.
boolean	isNoError()
boolean	isSuccess()
static EErrorLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static EErrorLevel[]	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

Enum Constant Detail

SUCCESS

public static final EErrorLevel SUCCESS

Success

INFO

public static final EErrorLevel INFO

Information level

WARN

public static final EErrorLevel WARN

Warning level.

ERROR

public static final EErrorLevel ERROR

Error level

FATAL_ERROR

public static final EErrorLevel FATAL_ERROR

Fatal error

Field Detail

LOWEST

public static final EErrorLevel LOWEST

Lowest error level within this enum

HIGHEST

public static final EErrorLevel HIGHEST

Highest error level within this enum

Method Detail

values

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

Returns:

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

valueOf

public static EErrorLevel 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.

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true on success and false on failure.

isFailure

public boolean isFailure()

Specified by:

isFailure in interface ISuccessIndicator

Returns:

true on failure and false on success.

isError

public boolean isError()

Specified by:

isError in interface IErrorIndicator

Returns:

true if the severity of this item is ≥ than ERROR.

isNoError

public boolean isNoError()

Specified by:

isNoError in interface IErrorIndicator

Returns:

true if the severity of this item is < than ERROR.

getNumericLevel

@Nonnegative
public int getNumericLevel()

Specified by:

getNumericLevel in interface IErrorLevel

Returns:

The numeric level of this error level. Must be ≥ 0. The higher the numeric level, the higher the priority of the error level. So e.g. ERROR has a higher/larger/greater numerical level than WARNING.

isEqualSevereThan

public boolean isEqualSevereThan(@Nonnull
                        IErrorLevel aErrorLevel)

Description copied from interface: ISeverityComparable

Check if this object is of the same level (= equal important) than the passed object.

Specified by:

isEqualSevereThan in interface ISeverityComparable<IErrorLevel>

Parameters:

aErrorLevel - The object to compare to.

Returns:

true if this object is equally important than the passed object!

isLessSevereThan

public boolean isLessSevereThan(@Nonnull
                       IErrorLevel aErrorLevel)

Description copied from interface: ISeverityComparable

Check if this object is of lower level (= less important) than the passed object.

Specified by:

isLessSevereThan in interface ISeverityComparable<IErrorLevel>

Parameters:

aErrorLevel - The object to compare to.

Returns:

true if this object is less important than the passed object!

isLessOrEqualSevereThan

public boolean isLessOrEqualSevereThan(@Nonnull
                              IErrorLevel aErrorLevel)

Description copied from interface: ISeverityComparable

Check if this object is of equal or lower level (= equally or less important) than the passed object.

Specified by:

isLessOrEqualSevereThan in interface ISeverityComparable<IErrorLevel>

Parameters:

aErrorLevel - The object to compare to.

Returns:

true if this object is equally or less important than the passed object!

isMoreSevereThan

public boolean isMoreSevereThan(@Nonnull
                       IErrorLevel aErrorLevel)

Description copied from interface: ISeverityComparable

Check if this object is of higher level (= more important) than the passed object.

Specified by:

isMoreSevereThan in interface ISeverityComparable<IErrorLevel>

Parameters:

aErrorLevel - The object to compare to.

Returns:

true if this object is more important than the passed object!

isMoreOrEqualSevereThan

public boolean isMoreOrEqualSevereThan(@Nonnull
                              IErrorLevel aErrorLevel)

Description copied from interface: ISeverityComparable

Check if this object is of equal or higher level (= equally or more important) than the passed object.

Specified by:

isMoreOrEqualSevereThan in interface ISeverityComparable<IErrorLevel>

Parameters:

aErrorLevel - The object to compare to.

Returns:

true if this object is equally or more important than the passed object!

getMostSevere

@Nullable
public static IErrorLevel getMostSevere(@Nullable
                                 IErrorLevel eLevel1,
                                 @Nullable
                                 IErrorLevel eLevel2)

getFromIDOrNull

@Nullable
public static EErrorLevel getFromIDOrNull(@Nullable
                                   String sID)

getFromIDOrThrow

@Nonnull
public static EErrorLevel getFromIDOrThrow(@Nullable
                                   String sID)

getFromIDOrDefault

@Nullable
public static EErrorLevel getFromIDOrDefault(@Nullable
                                      String sID,
                                      @Nullable
                                      EErrorLevel eDefault)

getFromIDCaseInsensitiveOrNull

@Nullable
public static EErrorLevel getFromIDCaseInsensitiveOrNull(@Nullable
                                                  String sID)

getFromIDCaseInsensitiveOrThrow

@Nonnull
public static EErrorLevel getFromIDCaseInsensitiveOrThrow(@Nullable
                                                  String sID)

getFromIDCaseInsensitiveOrDefault

@Nullable
public static EErrorLevel getFromIDCaseInsensitiveOrDefault(@Nullable
                                                     String sID,
                                                     @Nullable
                                                     EErrorLevel eDefault)