com.helger.commons.errorlist

Interface IError

All Superinterfaces:

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

All Known Implementing Classes:

SingleError

public interface IError
extends IHasErrorID, IErrorBase<IError>

Base interface for a single error, that has an error ID, and error level, and error field name and an error text.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
String	getErrorFieldName()
String	getErrorText()
default IResourceLocation	getResourceLocation()
default boolean	hasErrorFieldName()
default boolean	hasErrorFieldName(String sErrorFieldName) Check if this error has the passed error field name,
default boolean	hasNoErrorFieldName()

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

getComparatorErrorID, getErrorID, hasErrorID

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

getErrorFieldName

@Nullable
String getErrorFieldName()

Returns:

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

hasErrorFieldName

default boolean hasErrorFieldName()

Returns:

true if a field name is present, false otherwise

hasNoErrorFieldName

default boolean hasNoErrorFieldName()

Returns:

true if no field name is present, false otherwise

hasErrorFieldName

default boolean hasErrorFieldName(@Nullable
                                  String sErrorFieldName)

Check if this error has the passed error field name,

Parameters:

sErrorFieldName - The error field name to check. May be null.

Returns:

true if a field name is equal, false otherwise

getResourceLocation

@Nullable
default IResourceLocation getResourceLocation()

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
 @Nonempty
String getErrorText()

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.