com.helger.commons.errorlist

Class SingleError

java.lang.Object

com.helger.commons.errorlist.SingleError

All Implemented Interfaces:

IHasErrorID, IHasErrorLevel, ISeverityComparable<IError>, IError, IErrorBase<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()
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.errorlist.IError

getResourceLocation, hasErrorFieldName, hasErrorFieldName, hasNoErrorFieldName

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

getComparatorErrorID, hasErrorID

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

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.

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.

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.

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)