com.helger.commons.errorlist

Class ErrorList

java.lang.Object

com.helger.commons.errorlist.ErrorList

All Implemented Interfaces:

IHasErrorLevels, IErrorList, IFieldErrorList, ICloneable<ErrorList>, IClearable, Serializable, Iterable<IError>

@NotThreadSafe
public class ErrorList
extends Object
implements IErrorList, IClearable, ICloneable<ErrorList>

Handles a list of form global errors.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ErrorList()
ErrorList(Collection<? extends IError> aErrorList)
ErrorList(ErrorList aErrorList)
ErrorList(IError... aErrorList)
ErrorList(IErrorList aErrorList)

Method Summary

Modifier and Type	Method and Description
void	add(IError aItem) Add a new item.
void	addAll(Collection<? extends IError> aErrorList)
void	addAll(IError... aErrorList)
void	addAll(IErrorList aErrorList)
void	addError(String sText)
void	addError(String sFieldName, String sText)
void	addError(String sID, String sFieldName, String sText)
void	addInfo(String sText)
void	addInfo(String sFieldName, String sText)
void	addInfo(String sID, String sFieldName, String sText)
void	addSuccess(String sText)
void	addSuccess(String sFieldName, String sText)
void	addSuccess(String sID, String sFieldName, String sText)
void	addWarning(String sText)
void	addWarning(String sFieldName, String sText)
void	addWarning(String sID, String sFieldName, String sText)
EChange	clear() Reset the contents of the element to the after-construction state.
boolean	containsAtLeastOneError() Check if this group contains at least one error or fatal error message.
boolean	containsAtLeastOneFailure() Check if this group contains at least one failure message.
boolean	containsAtLeastOneSuccess() Check if this group contains at least one success message.
boolean	containsNoError() Check if this group contains no error or fatal error message.
boolean	containsNoFailure() Check if this group contains no failure message.
boolean	containsNoSuccess() Check if this group contains no success message.
boolean	containsOnlyError() Check if this group contains only error or fatal error messages.
boolean	containsOnlyFailure() Check if this group contains only failure messages.
boolean	containsOnlySuccess() Check if this group contains only success messages.
boolean	equals(Object o)
ICommonsList<IError>	getAllItems()
ICommonsList<String>	getAllItemTexts()
ICommonsList<String>	getAllItemTextsOfField(String sSearchFieldName) Get a list with all texts for the specified field name.
ICommonsList<String>	getAllItemTextsOfFields(String... aSearchFieldNames) Get a list with all texts for the specified field names
ICommonsList<String>	getAllItemTextsOfFieldsRegExp(String sRegEx) Get a list with all texts of entries that have field names matching the passed regular expression.
ICommonsList<String>	getAllItemTextsOfFieldsStartingWith(String... aSearchFieldNames) Get a list with all texts of entries that have field names starting with one of the supplied names.
ErrorList	getClone()
int	getErrorCount()
int	getFailureCount()
int	getItemCount()
ErrorList	getListOfField(String sSearchFieldName) Get a sub-list with all entries for the specified field name
ErrorList	getListOfFields(String... aSearchFieldNames) Get a sub-list with all entries for the specified field names
ErrorList	getListOfFieldsRegExp(String sRegExp) Get a sub-list with all entries that have field names matching the passed regular expression.
ErrorList	getListOfFieldsStartingWith(String... aSearchFieldNames) Get a sub-list with all entries that have field names starting with one of the supplied names.
ErrorList	getListWithoutField()
IErrorLevel	getMostSevereErrorLevel() Get the most severe error level within this object.
IMultiMapListBased<String,IError>	getStructuredByFieldName()
IMultiMapListBased<String,IError>	getStructuredByID()
int	getSuccessCount()
boolean	hasEntryForField(String sSearchFieldName) Check if any entry for the specified field is present
boolean	hasEntryForField(String sSearchFieldName, IErrorLevel aErrorLevel) Check if any entry for the specified field and the specified error level is present
boolean	hasEntryForFields(String... aSearchFieldNames) Check if any entry for the specified fields are present
boolean	hasErrorsOrWarnings()
int	hashCode()
boolean	hasNoEntryForField(String sSearchFieldName) Check if no entry for the specified field is present
boolean	hasNoEntryForFields(String... aSearchFieldNames) Check if no entry for the specified fields are present
boolean	isEmpty()
Iterator<IError>	iterator()
EChange	remove(IError aError)
EChange	removeAll(Collection<? extends IError> aErrors)
EChange	removeAll(IError... aErrors)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ErrorList

public ErrorList()

ErrorList

public ErrorList(@Nullable
                 IErrorList aErrorList)

ErrorList

public ErrorList(@Nullable
                 ErrorList aErrorList)

ErrorList

public ErrorList(@Nullable
                 Collection<? extends IError> aErrorList)

ErrorList

public ErrorList(@Nullable
                 IError... aErrorList)

Method Detail

addAll

public final void addAll(@Nullable
                         IErrorList aErrorList)

addAll

public final void addAll(@Nullable
                         Collection<? extends IError> aErrorList)

addAll

public final void addAll(@Nullable
                         IError... aErrorList)

add

public final void add(@Nonnull
                      IError aItem)

Add a new item.

Parameters:

aItem - The item to be added. May not be null.

addSuccess

public void addSuccess(@Nonnull @Nonempty
                       String sText)

addSuccess

public void addSuccess(@Nullable
                       String sFieldName,
                       @Nonnull @Nonempty
                       String sText)

addSuccess

public void addSuccess(@Nullable
                       String sID,
                       @Nullable
                       String sFieldName,
                       @Nonnull @Nonempty
                       String sText)

addInfo

public void addInfo(@Nonnull @Nonempty
                    String sText)

addInfo

public void addInfo(@Nullable
                    String sFieldName,
                    @Nonnull @Nonempty
                    String sText)

addInfo

public void addInfo(@Nullable
                    String sID,
                    @Nullable
                    String sFieldName,
                    @Nonnull @Nonempty
                    String sText)

addWarning

public void addWarning(@Nonnull @Nonempty
                       String sText)

addWarning

public void addWarning(@Nullable
                       String sFieldName,
                       @Nonnull @Nonempty
                       String sText)

addWarning

public void addWarning(@Nullable
                       String sID,
                       @Nullable
                       String sFieldName,
                       @Nonnull @Nonempty
                       String sText)

addError

public void addError(@Nonnull @Nonempty
                     String sText)

addError

public void addError(@Nullable
                     String sFieldName,
                     @Nonnull @Nonempty
                     String sText)

addError

public void addError(@Nullable
                     String sID,
                     @Nullable
                     String sFieldName,
                     @Nonnull @Nonempty
                     String sText)

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IErrorList

Returns:

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

getItemCount

@Nonnegative
public int getItemCount()

Specified by:

getItemCount in interface IErrorList

Returns:

The number of contained items. Always ≥ 0.

hasErrorsOrWarnings

public boolean hasErrorsOrWarnings()

Specified by:

hasErrorsOrWarnings in interface IErrorList

Returns:

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

containsOnlySuccess

public boolean containsOnlySuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains only success messages. If no item is present, false is returned, since no success message is contained. If you want to check, if the list is empty or contains only success messages, use IHasErrorLevels.containsNoFailure() instead.

Specified by:

containsOnlySuccess in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have the error level success, false otherwise.

See Also:

IHasErrorLevels.containsNoFailure()

containsAtLeastOneSuccess

public boolean containsAtLeastOneSuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one success message.

Specified by:

containsAtLeastOneSuccess in interface IHasErrorLevels

Returns:

true if at least one success item is present, false otherwise.

containsNoSuccess

public boolean containsNoSuccess()

Description copied from interface: IHasErrorLevels

Check if this group contains no success message. This is also true, if the list is empty!

Specified by:

containsNoSuccess in interface IHasErrorLevels

Returns:

true if no success item is present, false otherwise.

getSuccessCount

@Nonnegative
public int getSuccessCount()

Specified by:

getSuccessCount in interface IHasErrorLevels

Returns:

The number of contained success messages. Always ≥ 0.

containsOnlyFailure

public boolean containsOnlyFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains only failure messages. If no item is present, false is returned. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsOnlyFailure in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have an error level indicating failure, false otherwise.

containsAtLeastOneFailure

public boolean containsAtLeastOneFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one failure message. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsAtLeastOneFailure in interface IHasErrorLevels

Returns:

true if at least one failure item is present, false otherwise.

containsNoFailure

public boolean containsNoFailure()

Description copied from interface: IHasErrorLevels

Check if this group contains no failure message. All error levels except EErrorLevel.SUCCESS are considered to be a failure!

Specified by:

containsNoFailure in interface IHasErrorLevels

Returns:

true if no failure item is present, false otherwise.

getFailureCount

@Nonnegative
public int getFailureCount()

Specified by:

getFailureCount in interface IHasErrorLevels

Returns:

The number of contained failure messages. Always ≥ 0.

containsOnlyError

public boolean containsOnlyError()

Description copied from interface: IHasErrorLevels

Check if this group contains only error or fatal error messages. If no item is present, false is returned. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsOnlyError in interface IHasErrorLevels

Returns:

true if at least one item is present, and if all items have an error level indicating error or fatal error, false otherwise.

containsAtLeastOneError

public boolean containsAtLeastOneError()

Description copied from interface: IHasErrorLevels

Check if this group contains at least one error or fatal error message. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsAtLeastOneError in interface IHasErrorLevels

Returns:

true if at least one error or fatal error item is present, false otherwise.

containsNoError

public boolean containsNoError()

Description copied from interface: IHasErrorLevels

Check if this group contains no error or fatal error message. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

Specified by:

containsNoError in interface IHasErrorLevels

Returns:

true if no error or fatal error item is present, false otherwise.

getErrorCount

@Nonnegative
public int getErrorCount()

Specified by:

getErrorCount in interface IHasErrorLevels

Returns:

The number of contained error messages. Always ≥ 0. All error levels ≥ EErrorLevel.ERROR are considered to be an error!

getMostSevereErrorLevel

@Nonnull
public IErrorLevel getMostSevereErrorLevel()

Description copied from interface: IHasErrorLevels

Get the most severe error level within this object. The severity is defined by EErrorLevel's severity model.

Specified by:

getMostSevereErrorLevel in interface IHasErrorLevels

Returns:

EErrorLevel.SUCCESS if no resource error is contained, the most severe contained error level otherwise.

getAllItemTexts

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<String> getAllItemTexts()

Specified by:

getAllItemTexts in interface IErrorList

Returns:

A non-null list of all contained texts, independent of the level.

getAllItems

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<IError> getAllItems()

Specified by:

getAllItems in interface IErrorList

Returns:

A copy of all contained items. Never null.

iterator

@Nonnull
public Iterator<IError> iterator()

Specified by:

iterator in interface Iterable<IError>

Returns:

An Iterator over all contained items. Never null.

getListWithoutField

@Nonnull
 @ReturnsMutableCopy
public ErrorList getListWithoutField()

Specified by:

getListWithoutField in interface IErrorList

Returns:

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

hasNoEntryForField

public boolean hasNoEntryForField(@Nullable
                                  String sSearchFieldName)

Description copied from interface: IFieldErrorList

Check if no entry for the specified field is present

Specified by:

hasNoEntryForField in interface IFieldErrorList

Parameters:

sSearchFieldName - The field name to search.

Returns:

true if no entry for the specified field is present

hasNoEntryForFields

public boolean hasNoEntryForFields(@Nullable
                                   String... aSearchFieldNames)

Description copied from interface: IFieldErrorList

Check if no entry for the specified fields are present

Specified by:

hasNoEntryForFields in interface IFieldErrorList

Parameters:

aSearchFieldNames - The field names to search.

Returns:

true if no entry for any of the specified fields is present

hasEntryForField

public boolean hasEntryForField(@Nullable
                                String sSearchFieldName)

Description copied from interface: IFieldErrorList

Check if any entry for the specified field is present

Specified by:

hasEntryForField in interface IFieldErrorList

Parameters:

sSearchFieldName - The field name to search.

Returns:

true if an entry for the specified field is present

hasEntryForField

public boolean hasEntryForField(@Nullable
                                String sSearchFieldName,
                                @Nullable
                                IErrorLevel aErrorLevel)

Description copied from interface: IFieldErrorList

Check if any entry for the specified field and the specified error level is present

Specified by:

hasEntryForField in interface IFieldErrorList

Parameters:

sSearchFieldName - The field name to search.

aErrorLevel - The exact form error level to search. May not be null

Returns:

true if an entry for the specified field is present that has exactly the specified form error level

hasEntryForFields

public boolean hasEntryForFields(@Nullable
                                 String... aSearchFieldNames)

Description copied from interface: IFieldErrorList

Check if any entry for the specified fields are present

Specified by:

hasEntryForFields in interface IFieldErrorList

Parameters:

aSearchFieldNames - The field names to search.

Returns:

true if an entry for at least one of the specified fields is present

getListOfField

@Nonnull
 @ReturnsMutableCopy
public ErrorList getListOfField(@Nullable
                                                                String sSearchFieldName)

Description copied from interface: IFieldErrorList

Get a sub-list with all entries for the specified field name

Specified by:

getListOfField in interface IFieldErrorList

Parameters:

sSearchFieldName - The field name to search.

Returns:

Never null.

getListOfFields

@Nonnull
 @ReturnsMutableCopy
public ErrorList getListOfFields(@Nullable
                                                                 String... aSearchFieldNames)

Description copied from interface: IFieldErrorList

Get a sub-list with all entries for the specified field names

Specified by:

getListOfFields in interface IFieldErrorList

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getListOfFieldsStartingWith

@Nonnull
 @ReturnsMutableCopy
public ErrorList getListOfFieldsStartingWith(@Nullable
                                                                             String... aSearchFieldNames)

Description copied from interface: IFieldErrorList

Get a sub-list with all entries that have field names starting with one of the supplied names.

Specified by:

getListOfFieldsStartingWith in interface IFieldErrorList

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getListOfFieldsRegExp

@Nonnull
 @ReturnsMutableCopy
public ErrorList getListOfFieldsRegExp(@Nonnull @Nonempty @RegEx
                                                                       String sRegExp)

Description copied from interface: IFieldErrorList

Get a sub-list with all entries that have field names matching the passed regular expression.

Specified by:

getListOfFieldsRegExp in interface IFieldErrorList

Parameters:

sRegExp - The regular expression to compare the entries against.

Returns:

Never null.

getAllItemTextsOfField

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<String> getAllItemTextsOfField(@Nullable
                                                                                   String sSearchFieldName)

Description copied from interface: IFieldErrorList

Get a list with all texts for the specified field name.

Specified by:

getAllItemTextsOfField in interface IFieldErrorList

Parameters:

sSearchFieldName - The field name to search.

Returns:

Never null.

getAllItemTextsOfFields

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<String> getAllItemTextsOfFields(@Nullable
                                                                                    String... aSearchFieldNames)

Description copied from interface: IFieldErrorList

Get a list with all texts for the specified field names

Specified by:

getAllItemTextsOfFields in interface IFieldErrorList

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getAllItemTextsOfFieldsStartingWith

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<String> getAllItemTextsOfFieldsStartingWith(@Nullable
                                                                                                String... aSearchFieldNames)

Description copied from interface: IFieldErrorList

Get a list with all texts of entries that have field names starting with one of the supplied names.

Specified by:

getAllItemTextsOfFieldsStartingWith in interface IFieldErrorList

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getAllItemTextsOfFieldsRegExp

@Nonnull
 @ReturnsMutableCopy
public ICommonsList<String> getAllItemTextsOfFieldsRegExp(@Nonnull @Nonempty @RegEx
                                                                                          String sRegEx)

Description copied from interface: IFieldErrorList

Get a list with all texts of entries that have field names matching the passed regular expression.

Specified by:

getAllItemTextsOfFieldsRegExp in interface IFieldErrorList

Parameters:

sRegEx - The regular expression to compare the entries against.

Returns:

Never null.

getStructuredByID

@Nonnull
 @ReturnsMutableCopy
public IMultiMapListBased<String,IError> getStructuredByID()

Specified by:

getStructuredByID in interface IFieldErrorList

Returns:

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

getStructuredByFieldName

@Nonnull
 @ReturnsMutableCopy
public IMultiMapListBased<String,IError> getStructuredByFieldName()

Specified by:

getStructuredByFieldName in interface IFieldErrorList

Returns:

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

remove

@Nonnull
public EChange remove(@Nullable
                                IError aError)

removeAll

@Nonnull
public EChange removeAll(@Nullable
                                   IError... aErrors)

removeAll

@Nonnull
public EChange removeAll(@Nullable
                                   Collection<? extends IError> aErrors)

clear

@Nonnull
public EChange clear()

Description copied from interface: IClearable

Reset the contents of the element to the after-construction state.

Specified by:

clear in interface IClearable

Returns:

EChange.CHANGED if at least one element was cleared, EChange.UNCHANGED otherwise.

getClone

@Nonnull
public ErrorList getClone()

Specified by:

getClone in interface ICloneable<ErrorList>

Returns:

A 100% deep-copy of the implementing class.

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