com.phloc.validation.error.IErrorList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-validation Show documentation
There is a newer version: 3.3.0
/**
 * 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 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.error.IHasErrorLevels;

/**
 * A simple read only form error list interface. For a field specific list look
 * at {@link IErrorList}.
 * 
 * @author Philip Helger
 */
public interface IErrorList extends Iterable , IHasErrorLevels, Serializable
{
  /**
   * @return true if this list has no items, false if
   *         at least one item is contained
   */
  boolean isEmpty ();

  /**
   * @return The number of contained items. Always ≥ 0.
   */
  @Nonnegative
  int getItemCount ();

  /**
   * @return true if at least 1 item of level warning or at least 1
   *         item of level error is contained.
   */
  boolean hasErrorsOrWarnings ();

  /**
   * @return An immutable list of all contained entries. Never null
   *         .
   */
  @Nonnull
  @ReturnsMutableCopy
  List  getAllItems ();

  /**
   * @return The error texts of all contained {@link IError} objects. Never
   *         null.
   */
  @Nonnull
  @ReturnsMutableCopy
  List  getAllItemTexts ();

  // --- field specific methods ---

  /**
   * @return An error list with all entries that don't have a field assigned.
   */
  @Nonnull
  @ReturnsMutableCopy
  IErrorList getListWithoutField ();

  /**
   * Check if any entry for the specified field is present
   * 
   * @param sSearchFieldName
   *        The field name to search.
   * @return true if an entry for the specified field is present
   */
  boolean hasEntryForField (@Nullable String sSearchFieldName);

  /**
   * Check if any entry for the specified field and the specified error level is
   * present
   * 
   * @param sSearchFieldName
   *        The field name to search.
   * @param eErrorLevel
   *        The form error level to search. May not be null
   * @return true if an entry for the specified field is present
   *         that has exactly the specified form error level
   */
  boolean hasEntryForField (@Nullable String sSearchFieldName, @Nullable EErrorLevel eErrorLevel);

  /**
   * Get a sub-list with all entries for the specified field name
   * 
   * @param sSearchFieldName
   *        The field name to search.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  IErrorList getListOfField (@Nullable String sSearchFieldName);

  /**
   * Get a sub-list with all entries for the specified field names
   * 
   * @param aSearchFieldNames
   *        The field names to search.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  IErrorList getListOfFields (@Nullable String... aSearchFieldNames);

  /**
   * Get a sub-list with all entries that have field names starting with one of
   * the supplied names.
   * 
   * @param aSearchFieldNames
   *        The field names to search.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  IErrorList getListOfFieldsStartingWith (@Nullable String... aSearchFieldNames);

  /**
   * Get a sub-list with all entries that have field names matching the passed
   * regular expression.
   * 
   * @param sRegExp
   *        The regular expression to compare the entries against.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  IErrorList getListOfFieldsRegExp (@Nonnull @Nonempty @RegEx String sRegExp);

  /**
   * Get a list with all texts for the specified field name.
   * 
   * @param sSearchFieldName
   *        The field name to search.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  List  getAllItemTextsOfField (@Nullable String sSearchFieldName);

  /**
   * Get a list with all texts for the specified field names
   * 
   * @param aSearchFieldNames
   *        The field names to search.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  List  getAllItemTextsOfFields (@Nullable String... aSearchFieldNames);

  /**
   * Get a list with all texts of entries that have field names starting with
   * one of the supplied names.
   * 
   * @param aSearchFieldNames
   *        The field names to search.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  List  getAllItemTextsOfFieldsStartingWith (@Nullable String... aSearchFieldNames);

  /**
   * Get a list with all texts of entries that have field names matching the
   * passed regular expression.
   * 
   * @param sRegExp
   *        The regular expression to compare the entries against.
   * @return Never null.
   */
  @Nonnull
  @ReturnsMutableCopy
  List  getAllItemTextsOfFieldsRegExp (@Nonnull @Nonempty @RegEx String sRegExp);

  /**
   * @return A map with all items mapped from error ID to its occurrences.
   */
  @Nonnull
  @ReturnsMutableCopy
  IMultiMapListBased  getStructuredByID ();

  /**
   * @return A map with all items mapped from error field name to its
   *         occurrences.
   */
  @Nonnull
  @ReturnsMutableCopy
  IMultiMapListBased  getStructuredByFieldName ();
}