com.helger.commons.errorlist

Class SingleError

java.lang.Object

com.helger.commons.errorlist.SingleError

All Implemented Interfaces:

IHasErrorID, IHasErrorLevel, ISeverityComparable<IError>, IError, IErrorIndicator, ISuccessIndicator, Serializable

@Immutable
public class SingleError
extends Object
implements IError

Represents an overall form error. Default implementation of IError.
Note: cannot be named 'Error' as it should be because of the standard java exception class 'Error'.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SingleError(IErrorLevel aErrorLevel, String sErrorText)
SingleError(IErrorLevel aErrorLevel, String sErrorFieldName, String sErrorText)
SingleError(String sErrorID, IErrorLevel aErrorLevel, String sErrorFieldName, String sErrorText)

Method Summary

Modifier and Type	Method and Description
static SingleError	createError(String sErrorText)
static SingleError	createError(String sErrorFieldName, String sErrorText)
static SingleError	createError(String sErrorID, String sErrorFieldName, String sErrorText)
static SingleError	createInfo(String sErrorText)
static SingleError	createInfo(String sErrorFieldName, String sErrorText)
static SingleError	createInfo(String sErrorID, String sErrorFieldName, String sErrorText)
static SingleError	createSuccess(String sErrorText)
static SingleError	createSuccess(String sErrorFieldName, String sErrorText)
static SingleError	createSuccess(String sErrorID, String sErrorFieldName, String sErrorText)
static SingleError	createWarning(String sErrorText)
static SingleError	createWarning(String sErrorFieldName, String sErrorText)
static SingleError	createWarning(String sErrorID, String sErrorFieldName, String sErrorText)
boolean	equals(Object o)
String	getErrorFieldName()
String	getErrorID()
IErrorLevel	getErrorLevel()
String	getErrorText()
IResourceLocation	getResourceLocation()
boolean	hasErrorFieldName()
boolean	hasErrorID()
int	hashCode()
boolean	isEqualSevereThan(IError aOther) Check if this object is of the same level (= equal important) than the passed object.
boolean	isError()
boolean	isFailure()
boolean	isLessOrEqualSevereThan(IError aOther) Check if this object is of equal or lower level (= equally or less important) than the passed object.
boolean	isLessSevereThan(IError aOther) Check if this object is of lower level (= less important) than the passed object.
boolean	isMoreOrEqualSevereThan(IError aOther) Check if this object is of equal or higher level (= equally or more important) than the passed object.
boolean	isMoreSevereThan(IError 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

SingleError

public SingleError(@Nonnull
                   IErrorLevel aErrorLevel,
                   @Nonnull @Nonempty
                   String sErrorText)

SingleError

public SingleError(@Nonnull
                   IErrorLevel aErrorLevel,
                   @Nullable
                   String sErrorFieldName,
                   @Nonnull @Nonempty
                   String sErrorText)

SingleError

public SingleError(@Nullable
                   String sErrorID,
                   @Nonnull
                   IErrorLevel aErrorLevel,
                   @Nullable
                   String sErrorFieldName,
                   @Nonnull @Nonempty
                   String sErrorText)

Method Detail

getErrorID

@Nullable
public String getErrorID()

Specified by:

getErrorID in interface IHasErrorID

Returns:

The error ID. May be null.

hasErrorID

public boolean hasErrorID()

Specified by:

hasErrorID in interface IHasErrorID

Returns:

true if an error ID is present, false otherwise

getErrorLevel

@Nonnull
public IErrorLevel getErrorLevel()

Specified by:

getErrorLevel in interface IHasErrorLevel

Returns:

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

getErrorFieldName

@Nullable
public String getErrorFieldName()

Specified by:

getErrorFieldName in interface IError

Returns:

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

hasErrorFieldName

public boolean hasErrorFieldName()

Specified by:

hasErrorFieldName in interface IError

Returns:

true if a field name is present, false otherwise

getResourceLocation

@Nullable
public IResourceLocation getResourceLocation()

Specified by:

getResourceLocation in interface IError

Returns:

The error field name of this object as an IResourceLocation . If no error field name is present, null is returned, else an IResourceLocation with the field name set is returned.

getErrorText

@Nonnull
public String getErrorText()

Specified by:

getErrorText in interface IError

Returns:

The message of this form error. The error text is always locale specific because this error is meant to be for a single form instance represented in a fixed locale. The result may neither be null nor empty.

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

Parameters:

aOther - The object to compare to.

Returns:

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

isLessSevereThan

public boolean isLessSevereThan(@Nonnull
                                IError 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<IError>

Parameters:

aOther - The object to compare to.

Returns:

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

isLessOrEqualSevereThan

public boolean isLessOrEqualSevereThan(@Nonnull
                                       IError 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<IError>

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

Parameters:

aOther - The object to compare to.

Returns:

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

isMoreOrEqualSevereThan

public boolean isMoreOrEqualSevereThan(@Nonnull
                                       IError 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<IError>

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

createSuccess

@Nonnull
public static SingleError createSuccess(@Nonnull @Nonempty
                                                  String sErrorText)

createSuccess

@Nonnull
public static SingleError createSuccess(@Nullable
                                                  String sErrorFieldName,
                                                  @Nonnull @Nonempty
                                                  String sErrorText)

createSuccess

@Nonnull
public static SingleError createSuccess(@Nullable
                                                  String sErrorID,
                                                  @Nullable
                                                  String sErrorFieldName,
                                                  @Nonnull @Nonempty
                                                  String sErrorText)

createInfo

@Nonnull
public static SingleError createInfo(@Nonnull @Nonempty
                                               String sErrorText)

createInfo

@Nonnull
public static SingleError createInfo(@Nullable
                                               String sErrorFieldName,
                                               @Nonnull @Nonempty
                                               String sErrorText)

createInfo

@Nonnull
public static SingleError createInfo(@Nullable
                                               String sErrorID,
                                               @Nullable
                                               String sErrorFieldName,
                                               @Nonnull @Nonempty
                                               String sErrorText)

createWarning

@Nonnull
public static SingleError createWarning(@Nonnull @Nonempty
                                                  String sErrorText)

createWarning

@Nonnull
public static SingleError createWarning(@Nullable
                                                  String sErrorFieldName,
                                                  @Nonnull @Nonempty
                                                  String sErrorText)

createWarning

@Nonnull
public static SingleError createWarning(@Nullable
                                                  String sErrorID,
                                                  @Nullable
                                                  String sErrorFieldName,
                                                  @Nonnull @Nonempty
                                                  String sErrorText)

createError

@Nonnull
public static SingleError createError(@Nonnull @Nonempty
                                                String sErrorText)

createError

@Nonnull
public static SingleError createError(@Nullable
                                                String sErrorFieldName,
                                                @Nonnull @Nonempty
                                                String sErrorText)

createError

@Nonnull
public static SingleError createError(@Nullable
                                                String sErrorID,
                                                @Nullable
                                                String sErrorFieldName,
                                                @Nonnull @Nonempty
                                                String sErrorText)