com.helger.commons.error

Class SingleError

java.lang.Object

com.helger.commons.error.SingleError

All Implemented Interfaces:

IHasErrorField, IHasErrorID, IError, IHasErrorLevel, IHasErrorLevelComparable<IError>, ISeverityComparable<IError>, IErrorIndicator, ISuccessIndicator, IGenericImplTrait<IError>, Serializable

@Immutable
public class SingleError
extends Object
implements IError

Default implementation of IError.
Note: cannot be called Error because this would conflict with the default Java Exception class.

Since:

8.5.0

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingleError.AbstractBuilder<T extends SingleError,IMPLTYPE extends SingleError.AbstractBuilder<T,IMPLTYPE>> Abstract builder class for SingleError and derived classes.
static class	SingleError.SingleErrorBuilder

Constructor Summary

Constructors

Constructor and Description
SingleError(IErrorLevel aErrorLevel, String sErrorID, String sErrorFieldName, IErrorLocation aErrorLocation, IHasErrorText aErrorText, Throwable aLinkedException)

Method Summary

Modifier and Type	Method and Description
static SingleError.SingleErrorBuilder	builder() Create a new empty error builder with the default error level from SingleError.SingleErrorBuilder.
static SingleError.SingleErrorBuilder	builder(IError aError) Create a new error builder containing all the data from the provided error.
static SingleError.SingleErrorBuilder	builderError() Create a new empty error builder with the ERROR error level.
static SingleError.SingleErrorBuilder	builderFatalError() Create a new empty error builder with the FATAL ERROR error level.
static SingleError.SingleErrorBuilder	builderInfo() Create a new empty error builder with the INFO error level.
static SingleError.SingleErrorBuilder	builderSuccess() Create a new empty error builder with the SUCCESS error level.
static SingleError.SingleErrorBuilder	builderWarn() Create a new empty error builder with the WARN error level.
boolean	equals(Object o)
protected boolean	equalsLinkedException(Throwable t1, Throwable t2) Overridable implementation of Throwable for the Linked exception field.
String	getErrorFieldName()
String	getErrorID()
IErrorLevel	getErrorLevel()
IErrorLocation	getErrorLocation()
IHasErrorText	getErrorTexts()
Throwable	getLinkedException()
int	hashCode()
protected void	hashCodeLinkedException(HashCodeGenerator aHCG, Throwable t) Overridable implementation of Throwable for the Linked exception field.
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.IError

getAsString, getErrorText, getLinkedExceptionCause, getLinkedExceptionMessage, getLinkedExceptionStackTrace, hasErrorLocation, hasLinkedException

Methods inherited from interface com.helger.commons.error.level.IHasErrorLevelComparable

isEqualSevereThan, isLessOrEqualSevereThan, isLessSevereThan, isMoreOrEqualSevereThan, isMoreSevereThan

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

hasErrorLevel, isError, isFailure, isNoError, isSuccess

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

and, or

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.error.id.IHasErrorID

getComparatorErrorID, hasErrorID, hasErrorID, hasNoErrorID

Methods inherited from interface com.helger.commons.error.field.IHasErrorField

getComparatorErrorFieldName, hasErrorFieldName, hasErrorFieldName, hasNoErrorFieldName

Constructor Detail

SingleError

public SingleError(@Nonnull
                   IErrorLevel aErrorLevel,
                   @Nullable
                   String sErrorID,
                   @Nullable
                   String sErrorFieldName,
                   @Nullable
                   IErrorLocation aErrorLocation,
                   @Nullable
                   IHasErrorText aErrorText,
                   @Nullable
                   Throwable aLinkedException)

Method Detail

getErrorLevel

@Nonnull
public IErrorLevel getErrorLevel()

Specified by:

getErrorLevel in interface IHasErrorLevel

Returns:

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

getErrorID

@Nullable
public String getErrorID()

Description copied from interface: IError

Specified by:

getErrorID in interface IHasErrorID

Specified by:

getErrorID in interface IError

Returns:

The error ID. May be null.

getErrorFieldName

@Nullable
public String getErrorFieldName()

Specified by:

getErrorFieldName in interface IHasErrorField

Specified by:

getErrorFieldName in interface IError

Returns:

The field for which the error occurred. May be null.

getErrorLocation

@Nonnull
public IErrorLocation getErrorLocation()

Specified by:

getErrorLocation in interface IError

Returns:

The non-null location of the error. Use ErrorLocation.NO_LOCATION to indicate no location is available.

See Also:

IError.hasErrorLocation()

getErrorTexts

@Nullable
public IHasErrorText getErrorTexts()

Specified by:

getErrorTexts in interface IError

Returns:

The contained error message text. May be null.

See Also:

IError.getErrorText(Locale)

getLinkedException

@Nullable
public Throwable getLinkedException()

Specified by:

getLinkedException in interface IError

Returns:

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

See Also:

IError.hasLinkedException(), IError.getLinkedExceptionMessage(), IError.getLinkedExceptionStackTrace(), IError.getLinkedExceptionCause()

equalsLinkedException

@OverrideOnDemand
protected boolean equalsLinkedException(@Nullable
                                                           Throwable t1,
                                                           @Nullable
                                                           Throwable t2)

Overridable implementation of Throwable for the Linked exception field. This can be overridden to implement a different algorithm. This is customizable because there is no default way of comparing Exceptions in Java. If you override this method you must also override hashCodeLinkedException(HashCodeGenerator, Throwable)!

Parameters:

t1 - First Throwable. May be null.

t2 - Second Throwable. May be null.

Returns:

true if they are equals (or both null)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCodeLinkedException

@OverrideOnDemand
protected void hashCodeLinkedException(@Nonnull
                                                          HashCodeGenerator aHCG,
                                                          @Nullable
                                                          Throwable t)

Overridable implementation of Throwable for the Linked exception field. This can be overridden to implement a different algorithm. This is customizable because there is no default way of hashing Exceptions in Java. If you override this method you must also override equalsLinkedException(Throwable, Throwable)!

Parameters:

aHCG - The hash code generator to append to. Never null.

t - The Throwable to append. May be null.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

@Nonnull
public static SingleError.SingleErrorBuilder builder()

Create a new empty error builder with the default error level from SingleError.SingleErrorBuilder.

Returns:

A new Error builder. Never null.

builder

@Nonnull
public static SingleError.SingleErrorBuilder builder(@Nonnull
                                                               IError aError)

Create a new error builder containing all the data from the provided error.

Parameters:

aError - The error to copy the data from

Returns:

A new Error builder containing all the data from the provided error. Never null.

builderSuccess

@Nonnull
public static SingleError.SingleErrorBuilder builderSuccess()

Create a new empty error builder with the SUCCESS error level.

Returns:

A new Error builder with default error level EErrorLevel.SUCCESS. Never null.

builderInfo

@Nonnull
public static SingleError.SingleErrorBuilder builderInfo()

Create a new empty error builder with the INFO error level.

Returns:

A new Error builder with default error level EErrorLevel.INFO. Never null.

builderWarn

@Nonnull
public static SingleError.SingleErrorBuilder builderWarn()

Create a new empty error builder with the WARN error level.

Returns:

A new Error builder with default error level EErrorLevel.WARN. Never null.

builderError

@Nonnull
public static SingleError.SingleErrorBuilder builderError()

Create a new empty error builder with the ERROR error level.

Returns:

A new Error builder with default error level EErrorLevel.ERROR. Never null.

builderFatalError

@Nonnull
public static SingleError.SingleErrorBuilder builderFatalError()

Create a new empty error builder with the FATAL ERROR error level.

Returns:

A new Error builder with default error level EErrorLevel.FATAL_ERROR. Never null.