ICollectionPropertyProcessor.java example

Explorer
jspresso-ce-master
/*
 * Copyright (c) 2005-2016 Vincent Vandenschrick. All rights reserved.
 *
 *  This file is part of the Jspresso framework.
 *
 *  Jspresso is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Jspresso is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with Jspresso.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.jspresso.framework.util.bean.integrity;

import java.util.Collection;

/**
 * This is an interface used to identify classes responsible for providing
 * component collection property integrity processors.
 *
 * @author Vincent Vandenschrick
 * @param <E>
 *          The type of the target.
 * @param <F>
 *          The type of the property (a subclass of collection).
 * @param <G>
 *          The type of element managed in the collection.
 */
@SuppressWarnings({"EmptyMethod", "UnusedParameters"})
public interface ICollectionPropertyProcessor<E, F extends Collection<G>, G>
    extends IPropertyProcessor<E, F> {

  /**
   * This method gets called whenever a value has been added to a collection
   * property on an component to which this processor is registered. This method
   * should throw an {@code IntegrityException} if pre-checks are not
   * valid.
   *
   * @param target
   *          the component the processor is ran on.
   * @param collection
   *          the actual value of the collection property accessed.
   * @param addedValue
   *          the value added in the collection.
   */
  void postprocessAdder(E target, F collection, G addedValue);

  /**
   * This method gets called whenever a value has been removed from a collection
   * property on an component to which this processor is registered. This method
   * should throw an {@code IntegrityException} if post-checks are not
   * valid.
   *
   * @param target
   *          the component the processor is ran on.
   * @param collection
   *          the actual value of the collection property accessed.
   * @param removedValue
   *          the value removed from the collection.
   */
  void postprocessRemover(E target, F collection, G removedValue);

  /**
   * This method gets called whenever a value is about to be added to a
   * collection property on an component to which this processor is registered.
   * This method should throw an {@code IntegrityException} if pre-checks
   * are not valid.
   *
   * @param target
   *          the component the processor is ran on.
   * @param collection
   *          the actual value of the collection property accessed.
   * @param addedValue
   *          the value added in the collection.
   */
  void preprocessAdder(E target, F collection, G addedValue);

  /**
   * This method gets called whenever a value is about to be removed from a
   * collection property on an component to which this processor is registered.
   * This method should throw an {@code IntegrityException} if pre-checks
   * are not valid.
   *
   * @param target
   *          the component the processor is ran on.
   * @param collection
   *          the actual value of the collection property accessed.
   * @param removedValue
   *          the value removed from the collection.
   */
  void preprocessRemover(E target, F collection, G removedValue);
}