com.phloc.validation.error.FormErrors Maven / Gradle / Ivy
/**
* Copyright (C) 2006-2014 phloc systems
* http://www.phloc.com
* office[at]phloc[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.phloc.validation.error;
import java.io.Serializable;
import java.util.List;
import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.RegEx;
import javax.annotation.concurrent.NotThreadSafe;
import com.phloc.commons.annotations.Nonempty;
import com.phloc.commons.annotations.ReturnsMutableCopy;
import com.phloc.commons.collections.multimap.IMultiMapListBased;
import com.phloc.commons.error.EErrorLevel;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.ToStringGenerator;
import com.phloc.commons.text.IPredefinedLocaleTextProvider;
/**
* Handles form field specific and form global error messages centrally.
*
* @author Philip Helger
*/
@NotThreadSafe
public class FormErrors implements Serializable
{
private final ErrorList m_aFormGlobalErrs = new ErrorList ();
private final ErrorList m_aFormFieldErrs = new ErrorList ();
public FormErrors ()
{}
public void addAll (@Nullable final FormErrors aErrors)
{
if (aErrors != null)
{
for (final IError aFormError : aErrors.getAllGlobalItems ())
addGlobalItem (aFormError);
for (final IError aFormFieldError : aErrors.getAllFieldItems ())
addFieldItem (aFormFieldError);
}
}
/**
* Add a form-global item
*
* @param aFormError
* The form error object to add. May not be null.
*/
public void addGlobalItem (@Nonnull final IError aFormError)
{
if (aFormError == null)
throw new NullPointerException ("FormError");
m_aFormGlobalErrs.add (aFormError);
}
/**
* Add a form-global information
*
* @param sText
* The text to use. May neither be null nor empty.
*/
public void addGlobalInfo (@Nonnull @Nonempty final String sText)
{
addGlobalItem (SingleError.createInfo (sText));
}
/**
* Add a form-global information
*
* @param aTextProvider
* The text provider to use. May not be null.
*/
public void addGlobalInfo (@Nonnull final IPredefinedLocaleTextProvider aTextProvider)
{
addGlobalInfo (aTextProvider.getText ());
}
/**
* Add a form-global warning
*
* @param sText
* The text to use. May neither be null nor empty.
*/
public void addGlobalWarning (@Nonnull @Nonempty final String sText)
{
addGlobalItem (SingleError.createWarning (sText));
}
/**
* Add a form-global warning
*
* @param aTextProvider
* The text provider to use. May not be null.
*/
public void addGlobalWarning (@Nonnull final IPredefinedLocaleTextProvider aTextProvider)
{
addGlobalWarning (aTextProvider.getText ());
}
/**
* Add a form-global error
*
* @param sText
* The text to use. May neither be null nor empty.
*/
public void addGlobalError (@Nonnull @Nonempty final String sText)
{
addGlobalItem (SingleError.createError (sText));
}
/**
* Add a form-global error
*
* @param aTextProvider
* The text provider to use. May not be null.
*/
public void addGlobalError (@Nonnull final IPredefinedLocaleTextProvider aTextProvider)
{
addGlobalError (aTextProvider.getText ());
}
/**
* Add a form field specific item
*
* @param aFormFieldError
* The form field error object to add. May not be null.
*/
public void addFieldItem (@Nonnull final IError aFormFieldError)
{
if (aFormFieldError == null)
throw new NullPointerException ("FormError");
m_aFormFieldErrs.add (aFormFieldError);
}
/**
* Add a field specific information message.
*
* @param sFieldName
* The field name for which the message is to be recorded. May neither
* be null nor empty.
* @param sText
* The text to use. May neither be null nor empty.
*/
public void addFieldInfo (@Nonnull @Nonempty final String sFieldName, @Nonnull @Nonempty final String sText)
{
addFieldItem (SingleError.createInfo (sFieldName, sText));
}
/**
* Add a field specific information message.
*
* @param sFieldName
* The field name for which the message is to be recorded. May neither
* be null nor empty.
* @param aTextProvider
* The text provider to use. May not be null.
*/
public void addFieldInfo (@Nonnull @Nonempty final String sFieldName,
@Nonnull final IPredefinedLocaleTextProvider aTextProvider)
{
addFieldInfo (sFieldName, aTextProvider.getText ());
}
/**
* Add a field specific warning message.
*
* @param sFieldName
* The field name for which the message is to be recorded. May neither
* be null nor empty.
* @param sText
* The text to use. May neither be null nor empty.
*/
public void addFieldWarning (@Nonnull @Nonempty final String sFieldName, @Nonnull @Nonempty final String sText)
{
addFieldItem (SingleError.createWarning (sFieldName, sText));
}
/**
* Add a field specific warning message.
*
* @param sFieldName
* The field name for which the message is to be recorded. May neither
* be null nor empty.
* @param aTextProvider
* The text provider to use. May not be null.
*/
public void addFieldWarning (@Nonnull @Nonempty final String sFieldName,
@Nonnull final IPredefinedLocaleTextProvider aTextProvider)
{
addFieldWarning (sFieldName, aTextProvider.getText ());
}
/**
* Add a field specific error message.
*
* @param sFieldName
* The field name for which the message is to be recorded. May neither
* be null nor empty.
* @param sText
* The text to use. May neither be null nor empty.
*/
public void addFieldError (@Nonnull @Nonempty final String sFieldName, @Nonnull @Nonempty final String sText)
{
addFieldItem (SingleError.createError (sFieldName, sText));
}
/**
* Add a field specific error message.
*
* @param sFieldName
* The field name for which the message is to be recorded. May neither
* be null nor empty.
* @param aTextProvider
* The text provider to use. May not be null.
*/
public void addFieldError (@Nonnull @Nonempty final String sFieldName,
@Nonnull final IPredefinedLocaleTextProvider aTextProvider)
{
addFieldError (sFieldName, aTextProvider.getText ());
}
/**
* Check if no message is contained overall.
*
* @return true if neither a form-global nor a form-field
* specific message is present, false otherwise.
*/
public boolean isEmpty ()
{
return m_aFormGlobalErrs.isEmpty () && m_aFormFieldErrs.isEmpty ();
}
/**
* @return true if form-global errors or warnings are present.
*/
public boolean hasGlobalErrorsOrWarnings ()
{
return m_aFormGlobalErrs.hasErrorsOrWarnings ();
}
/**
* @return true if form-field errors or warnings are present.
*/
public boolean hasFormFieldErrorsOrWarnings ()
{
return m_aFormFieldErrs.hasErrorsOrWarnings ();
}
/**
* @return true if form-global OR form-field errors or warnings
* are present.
*/
public boolean hasErrorsOrWarnings ()
{
return m_aFormGlobalErrs.hasErrorsOrWarnings () || m_aFormFieldErrs.hasErrorsOrWarnings ();
}
/**
* @return The number of global items. Always ≥ 0.
*/
@Nonnegative
public int getGlobalItemCount ()
{
return m_aFormGlobalErrs.getItemCount ();
}
/**
* @return The number of form-field-specific items. Always ≥ 0.
*/
@Nonnegative
public int getFieldItemCount ()
{
return m_aFormFieldErrs.getItemCount ();
}
/**
* Get the total number of items for both form-global and form-field-specific
* items
*
* @return The total item count. Always ≥ 0.
*/
@Nonnegative
public int getItemCount ()
{
return m_aFormGlobalErrs.getItemCount () + m_aFormFieldErrs.getItemCount ();
}
/**
* Get the most severe error level that was recorded. This considers
* form-global and form-field-specific messages.
*
* @return Never null.
*/
@Nonnull
public EErrorLevel getMostSevereErrorLevel ()
{
final EErrorLevel ret = m_aFormGlobalErrs.getMostSevereErrorLevel ();
final EErrorLevel ret2 = m_aFormFieldErrs.getMostSevereErrorLevel ();
return ret.isMoreSevereThan (ret2) ? ret : ret2;
}
/**
* @return A non-null list of form global errors.
*/
@Nonnull
@ReturnsMutableCopy
public List getAllGlobalItems ()
{
return m_aFormGlobalErrs.getAllItems ();
}
/**
* @return A non-null list of all form global error texts.
*/
@Nonnull
@ReturnsMutableCopy
public List getAllGlobalItemTexts ()
{
return m_aFormGlobalErrs.getAllItemTexts ();
}
public boolean hasNoEntryForField (@Nullable final String sSearchFieldName)
{
return m_aFormFieldErrs.hasNoEntryForField (sSearchFieldName);
}
/**
* @deprecated Use {@link #hasEntryForField(String)} instead
*/
@Deprecated
public boolean hasErrorsOrWarningsForField (@Nullable final String sSearchFieldName)
{
return hasEntryForField (sSearchFieldName);
}
public boolean hasEntryForField (@Nullable final String sSearchFieldName)
{
return m_aFormFieldErrs.hasEntryForField (sSearchFieldName);
}
public boolean hasEntryForField (@Nullable final String sSearchFieldName, @Nonnull final EErrorLevel eErrorLevel)
{
return m_aFormFieldErrs.hasEntryForField (sSearchFieldName, eErrorLevel);
}
public boolean hasErrorForField (@Nullable final String sSearchFieldName)
{
return hasEntryForField (sSearchFieldName, EErrorLevel.ERROR);
}
@Nonnull
@ReturnsMutableCopy
public IErrorList getListOfField (@Nullable final String sSearchFieldName)
{
return m_aFormFieldErrs.getListOfField (sSearchFieldName);
}
@Nonnull
@ReturnsMutableCopy
public IErrorList getListOfFields (@Nullable final String... aSearchFieldNames)
{
return m_aFormFieldErrs.getListOfFields (aSearchFieldNames);
}
@Nonnull
@ReturnsMutableCopy
public IErrorList getListOfFieldsStartingWith (@Nullable final String... aSearchFieldNames)
{
return m_aFormFieldErrs.getListOfFieldsStartingWith (aSearchFieldNames);
}
@Nonnull
@ReturnsMutableCopy
public IErrorList getListOfFieldsRegExp (@Nonnull @Nonempty @RegEx final String sRegExp)
{
return m_aFormFieldErrs.getListOfFieldsRegExp (sRegExp);
}
@Nonnull
@ReturnsMutableCopy
public List getAllItemTextsOfField (@Nullable final String sSearchFieldName)
{
return m_aFormFieldErrs.getAllItemTextsOfField (sSearchFieldName);
}
@Nonnull
@ReturnsMutableCopy
public List getAllItemTextsOfFields (@Nullable final String... aSearchFieldNames)
{
return m_aFormFieldErrs.getAllItemTextsOfFields (aSearchFieldNames);
}
@Nonnull
@ReturnsMutableCopy
public List getAllItemTextsOfFieldsStartingWith (@Nullable final String... aSearchFieldNames)
{
return m_aFormFieldErrs.getAllItemTextsOfFieldsStartingWith (aSearchFieldNames);
}
@Nonnull
@ReturnsMutableCopy
public List getAllItemTextsOfFieldsRegExp (@Nonnull @Nonempty @RegEx final String sRegExp)
{
return m_aFormFieldErrs.getAllItemTextsOfFieldsRegExp (sRegExp);
}
@Nonnull
@ReturnsMutableCopy
public List getAllFieldItems ()
{
return m_aFormFieldErrs.getAllItems ();
}
@Nonnull
@ReturnsMutableCopy
public List getAllFieldItemTexts ()
{
return m_aFormFieldErrs.getAllItemTexts ();
}
@Nonnull
@ReturnsMutableCopy
public IMultiMapListBased getStructuredByFieldName ()
{
return m_aFormFieldErrs.getStructuredByFieldName ();
}
@Override
public boolean equals (final Object o)
{
if (o == this)
return true;
if (!(o instanceof FormErrors))
return false;
final FormErrors rhs = (FormErrors) o;
return m_aFormGlobalErrs.equals (rhs.m_aFormGlobalErrs) && m_aFormFieldErrs.equals (rhs.m_aFormFieldErrs);
}
@Override
public int hashCode ()
{
return new HashCodeGenerator (this).append (m_aFormGlobalErrs).append (m_aFormFieldErrs).getHashCode ();
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("formGlobalErrors", m_aFormGlobalErrs)
.append ("formFieldErrors", m_aFormFieldErrs)
.toString ();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy