com.phloc.commons.error

Class ResourceError

java.lang.Object

com.phloc.commons.error.ResourceError

All Implemented Interfaces:

IHasErrorLevel, IResourceError, ISeverityComparable<IResourceError>, IHasDisplayText, IErrorIndicator, ISuccessIndicator, Serializable

@Immutable
public class ResourceError
extends Object
implements IResourceError

Default implementation of the IResourceError interface. The implementation is immutable.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ResourceError(IResourceLocation aLocation, EErrorLevel eErrorLevel, IHasDisplayText aErrorText)
ResourceError(IResourceLocation aLocation, EErrorLevel eErrorLevel, IHasDisplayText aErrorText, Throwable aLinkedException)
ResourceError(IResourceLocation aLocation, EErrorLevel eErrorLevel, String sErrorText)
ResourceError(IResourceLocation aLocation, EErrorLevel eErrorLevel, String sErrorText, Throwable aLinkedException)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAsString(Locale aDisplayLocale) Get the error as a string representation, including error ID, error location, error text and the linked exception.
String	getDisplayText(Locale aContentLocale)
EErrorLevel	getErrorLevel()
Throwable	getLinkedException()
IResourceLocation	getLocation()
int	hashCode()
boolean	isEqualSevereThan(IResourceError aOther) Check if this object is of the same level (= equal important) than the passed object.
boolean	isError()
boolean	isFailure()
boolean	isLessOrEqualSevereThan(IResourceError aOther) Check if this object is of equal or lower level (= equally or less important) than the passed object.
boolean	isLessSevereThan(IResourceError aOther) Check if this object is of lower level (= less important) than the passed object.
boolean	isMoreOrEqualSevereThan(IResourceError aOther) Check if this object is of equal or higher level (= equally or more important) than the passed object.
boolean	isMoreSevereThan(IResourceError aOther) 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

ResourceError

public ResourceError(@Nonnull
             IResourceLocation aLocation,
             @Nonnull
             EErrorLevel eErrorLevel,
             @Nonnull
             String sErrorText)

ResourceError

public ResourceError(@Nonnull
             IResourceLocation aLocation,
             @Nonnull
             EErrorLevel eErrorLevel,
             @Nonnull
             String sErrorText,
             @Nullable
             Throwable aLinkedException)

ResourceError

public ResourceError(@Nonnull
             IResourceLocation aLocation,
             @Nonnull
             EErrorLevel eErrorLevel,
             @Nonnull
             IHasDisplayText aErrorText)

ResourceError

public ResourceError(@Nonnull
             IResourceLocation aLocation,
             @Nonnull
             EErrorLevel eErrorLevel,
             @Nonnull
             IHasDisplayText aErrorText,
             @Nullable
             Throwable aLinkedException)

Method Detail

getLocation

@Nonnull
public final IResourceLocation getLocation()

Specified by:

getLocation in interface IResourceError

Returns:

The non-null location of the error.

getErrorLevel

@Nonnull
public final EErrorLevel getErrorLevel()

Specified by:

getErrorLevel in interface IHasErrorLevel

Returns:

The error level of this object. May not be null.

getDisplayText

@Nullable
@OverrideOnDemand
public String getDisplayText(@Nonnull
                                              Locale aContentLocale)

Specified by:

getDisplayText in interface IHasDisplayText

Parameters:

aContentLocale - The locale to be used for resolving. May not be null.

Returns:

The display text of the object in the given locale. May be null if the text could not be resolved in the passed locale.

getLinkedException

@Nullable
public final Throwable getLinkedException()

Specified by:

getLinkedException in interface IResourceError

Returns:

The linked exception or null if no such exception is available.

getAsString

@Nonnull
@OverrideOnDemand
public String getAsString(@Nonnull
                                          Locale aDisplayLocale)

Description copied from interface: IResourceError

Get the error as a string representation, including error ID, error location, error text and the linked exception.

Specified by:

getAsString in interface IResourceError

Parameters:

aDisplayLocale - Locale to resolve the error text

Returns:

The default string representation

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 this level is at least EErrorLevel.ERROR or worse.

isNoError

public boolean isNoError()

Specified by:

isNoError in interface IErrorIndicator

Returns:

true if this level is below EErrorLevel.ERROR.

isEqualSevereThan

public boolean isEqualSevereThan(@Nonnull
                        IResourceError aOther)

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<IResourceError>

Parameters:

aOther - The object to compare to.

Returns:

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

isLessSevereThan

public boolean isLessSevereThan(@Nonnull
                       IResourceError aOther)

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<IResourceError>

Parameters:

aOther - The object to compare to.

Returns:

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

isLessOrEqualSevereThan

public boolean isLessOrEqualSevereThan(@Nonnull
                              IResourceError aOther)

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<IResourceError>

Parameters:

aOther - The object to compare to.

Returns:

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

isMoreSevereThan

public boolean isMoreSevereThan(@Nonnull
                       IResourceError aOther)

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<IResourceError>

Parameters:

aOther - The object to compare to.

Returns:

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

isMoreOrEqualSevereThan

public boolean isMoreOrEqualSevereThan(@Nonnull
                              IResourceError aOther)

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<IResourceError>

Parameters:

aOther - 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