com.helger.commons.errorlist

Interface IErrorList

All Superinterfaces:

IFieldErrorList, IHasErrorLevels, Iterable<IError>, Serializable

All Known Implementing Classes:

ErrorList

public interface IErrorList
extends Iterable<IError>, IHasErrorLevels, IFieldErrorList, Serializable

A simple read only form error list interface. For a field specific list look at IErrorList.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
ICommonsList<IError>	getAllItems()
ICommonsList<String>	getAllItemTexts()
default IMultiMapListBased<String,IError>	getGroupedByFieldName()
default IMultiMapListBased<String,IError>	getGroupedByID()
int	getItemCount()
IErrorList	getListWithoutField()
boolean	hasErrorsOrWarnings()
boolean	isEmpty()
default boolean	isNotEmpty()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

containsAtLeastOneError, containsAtLeastOneFailure, containsAtLeastOneSuccess, containsNoError, containsNoFailure, containsNoSuccess, containsOnlyError, containsOnlyFailure, containsOnlySuccess, getErrorCount, getFailureCount, getMostSevereErrorLevel, getSuccessCount

Methods inherited from interface com.helger.commons.errorlist.IFieldErrorList

getAllItemTextsOfField, getAllItemTextsOfFields, getAllItemTextsOfFieldsRegExp, getAllItemTextsOfFieldsStartingWith, getListOfField, getListOfFields, getListOfFieldsRegExp, getListOfFieldsStartingWith, hasEntryForField, hasEntryForField, hasEntryForFields, hasNoEntryForField, hasNoEntryForFields

Method Detail

isEmpty

boolean isEmpty()

Returns:

true if this list has no items, false if at least one item is contained

isNotEmpty

default boolean isNotEmpty()

Returns:

true if this list has at least one item, false if if it is empty.

getItemCount

@Nonnegative
int getItemCount()

Returns:

The number of contained items. Always ≥ 0.

hasErrorsOrWarnings

boolean hasErrorsOrWarnings()

Returns:

true if at least 1 item of level warning or at least 1 item of level error is contained.

getAllItems

@Nonnull
 @ReturnsMutableCopy
ICommonsList<IError> getAllItems()

Returns:

An immutable list of all contained entries. Never null .

getAllItemTexts

@Nonnull
 @ReturnsMutableCopy
ICommonsList<String> getAllItemTexts()

Returns:

The error texts of all contained IError objects. Never null.

getListWithoutField

@Nonnull
 @ReturnsMutableCopy
IErrorList getListWithoutField()

Returns:

An error list with all entries that don't have a field assigned.

getGroupedByID

@Nonnull
 @ReturnsMutableCopy
default IMultiMapListBased<String,IError> getGroupedByID()

Specified by:

getGroupedByID in interface IFieldErrorList

Returns:

A map with all items mapped from error ID to its occurrences.

getGroupedByFieldName

@Nonnull
 @ReturnsMutableCopy
default IMultiMapListBased<String,IError> getGroupedByFieldName()

Specified by:

getGroupedByFieldName in interface IFieldErrorList

Returns:

A map with all items mapped from error field name to its occurrences.