com.helger.commons.error

Class ErrorLevel

java.lang.Object

com.helger.commons.error.ErrorLevel

All Implemented Interfaces:

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

@Immutable
public class ErrorLevel
extends Object
implements IErrorLevel

A standalone implementation of the IErrorLevel interface.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ErrorLevel(String sID, int nNumericLevel)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getID() Get the unique ID of this object.
int	getNumericLevel()
int	hashCode()
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()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ErrorLevel

public ErrorLevel(@Nonnull @Nonempty
                  String sID,
                  @Nonnegative
                  int nNumericLevel)

Method Detail

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 EErrorLevel.ERROR.

isNoError

public boolean isNoError()

Specified by:

isNoError in interface IErrorIndicator

Returns:

true if the severity of this item is < than EErrorLevel.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!

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object