com.helger.commons.error.level

Interface IErrorLevel

All Superinterfaces:

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

All Known Implementing Classes:

EErrorLevel, ErrorLevel

@MustImplementEqualsAndHashcode
public interface IErrorLevel
extends IHasID<String>, ISuccessIndicator, IErrorIndicator, ISeverityComparable<IErrorLevel>, Serializable

Interface representing a single error level.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static IErrorLevel	getMostSevere(IErrorLevel aLevel1, IErrorLevel aLevel2)
int	getNumericLevel()
default boolean	isEqualSevereThan(IErrorLevel aErrorLevel) Check if this object is of the same level (= equal important) than the passed object.
default boolean	isError()
default boolean	isFailure()
default boolean	isHighest()
default boolean	isLessOrEqualSevereThan(IErrorLevel aErrorLevel) Check if this object is of equal or lower level (= equally or less important) than the passed object.
default boolean	isLessSevereThan(IErrorLevel aErrorLevel) Check if this object is of lower level (= less important) than the passed object.
default boolean	isMoreOrEqualSevereThan(IErrorLevel aErrorLevel) Check if this object is of equal or higher level (= equally or more important) than the passed object.
default boolean	isMoreSevereThan(IErrorLevel aErrorLevel) Check if this object is of higher level (= more important) than the passed object.
default boolean	isNoError()
default boolean	isSuccess()

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

getComparatorID, getID

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

and, or

Method Detail

getNumericLevel

@Nonnegative
int getNumericLevel()

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.

isSuccess

default boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true on success and false on failure.

isFailure

default boolean isFailure()

Specified by:

isFailure in interface ISuccessIndicator

Returns:

true on failure and false on success.

isError

default boolean isError()

Specified by:

isError in interface IErrorIndicator

Returns:

true if this level is at least EErrorLevel.ERROR or worse.

isNoError

default boolean isNoError()

Specified by:

isNoError in interface IErrorIndicator

Returns:

true if this level is below EErrorLevel.ERROR.

isEqualSevereThan

default 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

default 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

default 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

default 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

default 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!

isHighest

default boolean isHighest()

getMostSevere

@Nullable
static IErrorLevel getMostSevere(@Nullable
                                            IErrorLevel aLevel1,
                                            @Nullable
                                            IErrorLevel aLevel2)