com.helger.commons.error

Interface IResourceError

All Superinterfaces:

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

All Known Implementing Classes:

ResourceError

public interface IResourceError
extends IHasDisplayText, IErrorBase<IResourceError>

Interface for an error that can be drilled down to a certain resource (e.g. a document). The name is a bit misleading, as an "IResourceError" can also contain an INFO or a WARNING message! It has an error level, a multilingual error message, a location and a linked exception.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
String	getAsString(Locale aDisplayLocale) Get the error as a string representation, including error ID, error location, error text and the linked exception.
Throwable	getLinkedException()
IResourceLocation	getLocation()
default boolean	hasLinkedException()

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

getComparatorCollating, getDisplayText

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

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

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

getErrorLevel

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

and, isFailure, or

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

isNoError

Method Detail

getLocation

@Nonnull
IResourceLocation getLocation()

Returns:

The non-null location of the error.

getLinkedException

@Nullable
Throwable getLinkedException()

Returns:

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

hasLinkedException

default boolean hasLinkedException()

Returns:

true if a linked exception is present, false if not.

getAsString

@Nonnull
 @Nonempty
String getAsString(@Nonnull
                                         Locale aDisplayLocale)

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

Parameters:

aDisplayLocale - Locale to resolve the error text

Returns:

The default string representation