com.helger.commons.errorlist

Interface IFieldErrorList

All Known Subinterfaces:

IErrorList

All Known Implementing Classes:

ErrorList, FormErrors

public interface IFieldErrorList

A subset of IErrorList containing only the methods relevant for fields

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
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.
IFieldErrorList	getListOfField(String sSearchFieldName) Get a sub-list with all entries for the specified field name
IFieldErrorList	getListOfFields(String... aSearchFieldNames) Get a sub-list with all entries for the specified field names
IFieldErrorList	getListOfFieldsRegExp(String sRegExp) Get a sub-list with all entries that have field names matching the passed regular expression.
IFieldErrorList	getListOfFieldsStartingWith(String... aSearchFieldNames) Get a sub-list with all entries that have field names starting with one of the supplied names.
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... aSearchFieldNames) Check if any entry for the specified fields are present
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

Method Detail

hasNoEntryForField

boolean hasNoEntryForField(@Nullable
                           String sSearchFieldName)

Check if no entry for the specified field is present

Parameters:

sSearchFieldName - The field name to search.

Returns:

true if no entry for the specified field is present

hasNoEntryForFields

boolean hasNoEntryForFields(@Nullable
                            String... aSearchFieldNames)

Check if no entry for the specified fields are present

Parameters:

aSearchFieldNames - The field names to search.

Returns:

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

hasEntryForField

boolean hasEntryForField(@Nullable
                         String sSearchFieldName)

Check if any entry for the specified field is present

Parameters:

sSearchFieldName - The field name to search.

Returns:

true if an entry for the specified field is present

hasEntryForField

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

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

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

boolean hasEntryForFields(@Nullable
                          String... aSearchFieldNames)

Check if any entry for the specified fields are present

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
IFieldErrorList getListOfField(@Nullable
                                                               String sSearchFieldName)

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

Parameters:

sSearchFieldName - The field name to search.

Returns:

Never null.

getListOfFields

@Nonnull
 @ReturnsMutableCopy
IFieldErrorList getListOfFields(@Nullable
                                                                String... aSearchFieldNames)

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

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getListOfFieldsStartingWith

@Nonnull
 @ReturnsMutableCopy
IFieldErrorList getListOfFieldsStartingWith(@Nullable
                                                                            String... aSearchFieldNames)

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

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getListOfFieldsRegExp

@Nonnull
 @ReturnsMutableCopy
IFieldErrorList getListOfFieldsRegExp(@Nonnull @Nonempty @RegEx
                                                                      String sRegExp)

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

Parameters:

sRegExp - The regular expression to compare the entries against.

Returns:

Never null.

getAllItemTextsOfField

@Nonnull
 @ReturnsMutableCopy
List<String> getAllItemTextsOfField(@Nullable
                                                                    String sSearchFieldName)

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

Parameters:

sSearchFieldName - The field name to search.

Returns:

Never null.

getAllItemTextsOfFields

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

Get a list with all texts for the specified field names

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getAllItemTextsOfFieldsStartingWith

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

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

Parameters:

aSearchFieldNames - The field names to search.

Returns:

Never null.

getAllItemTextsOfFieldsRegExp

@Nonnull
 @ReturnsMutableCopy
List<String> getAllItemTextsOfFieldsRegExp(@Nonnull @Nonempty @RegEx
                                                                           String sRegExp)

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

Parameters:

sRegExp - The regular expression to compare the entries against.

Returns:

Never null.

getStructuredByID

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

Returns:

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

getStructuredByFieldName

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

Returns:

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