com.helger.commons.errorlist

Class FormErrors

java.lang.Object

com.helger.commons.errorlist.FormErrors

All Implemented Interfaces:

IFieldErrorList, Serializable

@NotThreadSafe
public class FormErrors
extends Object
implements Serializable, IFieldErrorList

Handles form field specific and form global error messages centrally.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormErrors()

Method Summary

Modifier and Type	Method and Description
void	addAll(FormErrors aOther)
void	addFieldError(String sFieldName, String sText) Add a field specific error message.
void	addFieldInfo(String sFieldName, String sText) Add a field specific information message.
void	addFieldItem(IError aFormFieldError) Add a form field specific item
void	addFieldWarning(String sFieldName, String sText) Add a field specific warning message.
void	addGlobalError(String sText) Add a form-global error
void	addGlobalInfo(String sText) Add a form-global information
void	addGlobalItem(IError aFormError) Add a form-global item
void	addGlobalWarning(String sText) Add a form-global warning
EChange	clear()
boolean	equals(Object o)
List<IError>	getAllFieldItems()
List<String>	getAllFieldItemTexts()
List<IError>	getAllGlobalItems()
List<String>	getAllGlobalItemTexts()
List<String>	getAllItemTextsOfField(String sSearchFieldName) Get a list with all texts for the specified field name.
List<String>	getAllItemTextsOfFields(String... aSearchFieldNames) Get a list with all texts for the specified field names
List<String>	getAllItemTextsOfFieldsRegExp(String sRegExp) Get a list with all texts of entries that have field names matching the passed regular expression.
List<String>	getAllItemTextsOfFieldsStartingWith(String... aSearchFieldNames) Get a list with all texts of entries that have field names starting with one of the supplied names.
int	getFieldItemCount()
int	getGlobalItemCount()
int	getItemCount() Get the total number of items for both form-global and form-field-specific items
IErrorList	getListOfField(String sSearchFieldName) Get a sub-list with all entries for the specified field name
IErrorList	getListOfFields(String... aSearchFieldNames) Get a sub-list with all entries for the specified field names
IErrorList	getListOfFieldsRegExp(String sRegExp) Get a sub-list with all entries that have field names matching the passed regular expression.
IErrorList	getListOfFieldsStartingWith(String... aSearchFieldNames) Get a sub-list with all entries that have field names starting with one of the supplied names.
IErrorLevel	getMostSevereErrorLevel() Get the most severe error level that was recorded.
IMultiMapListBased<String,IError>	getStructuredByFieldName()
IMultiMapListBased<String,IError>	getStructuredByID()
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... aSearchFieldName) Check if any entry for the specified fields are present
boolean	hasErrorForField(String sSearchFieldName)
boolean	hasErrorsOrWarnings()
boolean	hasFormFieldErrorsOrWarnings()
boolean	hasGlobalErrorsOrWarnings()
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() Check if no message is contained overall.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FormErrors

public FormErrors()

Method Detail

addAll

public void addAll(@Nullable
                   FormErrors aOther)

addGlobalItem

public void addGlobalItem(@Nonnull
                          IError aFormError)

Add a form-global item

Parameters:

aFormError - The form error object to add. May not be null.

addGlobalInfo

public void addGlobalInfo(@Nonnull @Nonempty
                          String sText)

Add a form-global information

Parameters:

sText - The text to use. May neither be null nor empty.

addGlobalWarning

public void addGlobalWarning(@Nonnull @Nonempty
                             String sText)

Add a form-global warning

Parameters:

sText - The text to use. May neither be null nor empty.

addGlobalError

public void addGlobalError(@Nonnull @Nonempty
                           String sText)

Add a form-global error

Parameters:

sText - The text to use. May neither be null nor empty.

addFieldItem

public void addFieldItem(@Nonnull
                         IError aFormFieldError)

Add a form field specific item

Parameters:

aFormFieldError - The form field error object to add. May not be null.

addFieldInfo

public void addFieldInfo(@Nonnull @Nonempty
                         String sFieldName,
                         @Nonnull @Nonempty
                         String sText)

Add a field specific information message.

Parameters:

sFieldName - The field name for which the message is to be recorded. May neither be null nor empty.

sText - The text to use. May neither be null nor empty.

addFieldWarning

public void addFieldWarning(@Nonnull @Nonempty
                            String sFieldName,
                            @Nonnull @Nonempty
                            String sText)

Add a field specific warning message.

Parameters:

sFieldName - The field name for which the message is to be recorded. May neither be null nor empty.

sText - The text to use. May neither be null nor empty.

addFieldError

public void addFieldError(@Nonnull @Nonempty
                          String sFieldName,
                          @Nonnull @Nonempty
                          String sText)

Add a field specific error message.

Parameters:

sFieldName - The field name for which the message is to be recorded. May neither be null nor empty.

sText - The text to use. May neither be null nor empty.

isEmpty

public boolean isEmpty()

Check if no message is contained overall.

Returns:

true if neither a form-global nor a form-field specific message is present, false otherwise.

hasGlobalErrorsOrWarnings

public boolean hasGlobalErrorsOrWarnings()

Returns:

true if form-global errors or warnings are present.

hasFormFieldErrorsOrWarnings

public boolean hasFormFieldErrorsOrWarnings()

Returns:

true if form-field errors or warnings are present.

hasErrorsOrWarnings

public boolean hasErrorsOrWarnings()

Returns:

true if form-global OR form-field errors or warnings are present.

getGlobalItemCount

@Nonnegative
public int getGlobalItemCount()

Returns:

The number of global items. Always ≥ 0.

getFieldItemCount

@Nonnegative
public int getFieldItemCount()

Returns:

The number of form-field-specific items. Always ≥ 0.

getItemCount

@Nonnegative
public int getItemCount()

Get the total number of items for both form-global and form-field-specific items

Returns:

The total item count. Always ≥ 0.

getMostSevereErrorLevel

@Nonnull
public IErrorLevel getMostSevereErrorLevel()

Get the most severe error level that was recorded. This considers form-global and form-field-specific messages.

Returns:

Never null.

getAllGlobalItems

@Nonnull
 @ReturnsMutableCopy
public List<IError> getAllGlobalItems()

Returns:

A non-null list of form global errors.

getAllGlobalItemTexts

@Nonnull
 @ReturnsMutableCopy
public List<String> getAllGlobalItemTexts()

Returns:

A non-null list of all form global error texts.

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

hasEntryForFields

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

Description copied from interface: IFieldErrorList

Check if any entry for the specified fields are present

Specified by:

hasEntryForFields in interface IFieldErrorList

Parameters:

aSearchFieldName - The field names to search.

Returns:

true if an entry for at least one of the specified fields 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

hasErrorForField

public boolean hasErrorForField(@Nullable
                                String sSearchFieldName)

getListOfField

@Nonnull
 @ReturnsMutableCopy
public IErrorList 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 IErrorList 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 IErrorList 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 IErrorList 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 List<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 List<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 List<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 List<String> getAllItemTextsOfFieldsRegExp(@Nonnull @Nonempty @RegEx
                                                                                  String sRegExp)

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:

sRegExp - The regular expression to compare the entries against.

Returns:

Never null.

getAllFieldItems

@Nonnull
 @ReturnsMutableCopy
public List<IError> getAllFieldItems()

getAllFieldItemTexts

@Nonnull
 @ReturnsMutableCopy
public List<String> getAllFieldItemTexts()

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.

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.

clear

@Nonnull
public EChange clear()

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