com.helger.commons.error

Interface IResourceError

All Superinterfaces:

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

All Known Implementing Classes:

ResourceError

public interface IResourceError
extends IHasErrorLevel, IHasDisplayText, ISuccessIndicator, IErrorIndicator, ISeverityComparable<IResourceError>, Serializable

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 multi lingual error message, a location and a linked exception.

Author:

Philip Helger

Method Summary

Methods

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()

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

getErrorLevel

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

getDisplayText

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

isFailure, isSuccess

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

isError, isNoError

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

isEqualSevereThan, isLessOrEqualSevereThan, isLessSevereThan, isMoreOrEqualSevereThan, isMoreSevereThan

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.

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