com.helger.commons.error

Class ResourceError

java.lang.Object

com.helger.commons.error.ResourceError

All Implemented Interfaces:

IHasErrorLevel, IResourceError, ISeverityComparable<IResourceError>, IErrorBase<IResourceError>, IErrorIndicator, ISuccessIndicator, IHasDisplayText, 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, IErrorLevel aErrorLevel, IHasDisplayText aErrorText)
ResourceError(IResourceLocation aLocation, IErrorLevel aErrorLevel, IHasDisplayText aErrorText, Throwable aLinkedException)
ResourceError(IResourceLocation aLocation, IErrorLevel aErrorLevel, String sErrorText)
ResourceError(IResourceLocation aLocation, IErrorLevel aErrorLevel, String sErrorText, Throwable aLinkedException)

Method Summary

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)
IErrorLevel	getErrorLevel()
Throwable	getLinkedException()
IResourceLocation	getLocation()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.error.IResourceError

hasLinkedException

Methods inherited from interface com.helger.commons.text.display.IHasDisplayText

getComparatorCollating

Methods inherited from interface com.helger.commons.errorlist.IErrorBase

isEqualSevereThan, isError, isLessOrEqualSevereThan, isLessSevereThan, isMoreOrEqualSevereThan, isMoreSevereThan, isSuccess

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

and, isFailure, or

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

isNoError

Constructor Detail

ResourceError

public ResourceError(@Nonnull
                     IResourceLocation aLocation,
                     @Nonnull
                     IErrorLevel aErrorLevel,
                     @Nonnull
                     String sErrorText)

ResourceError

public ResourceError(@Nonnull
                     IResourceLocation aLocation,
                     @Nonnull
                     IErrorLevel aErrorLevel,
                     @Nonnull
                     String sErrorText,
                     @Nullable
                     Throwable aLinkedException)

ResourceError

public ResourceError(@Nonnull
                     IResourceLocation aLocation,
                     @Nonnull
                     IErrorLevel aErrorLevel,
                     @Nonnull
                     IHasDisplayText aErrorText)

ResourceError

public ResourceError(@Nonnull
                     IResourceLocation aLocation,
                     @Nonnull
                     IErrorLevel aErrorLevel,
                     @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 IErrorLevel 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

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