/*
    *  Copyright 2003-2004 The Apache Software Foundation
    *
    *  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 net.sf.collections15.list;
  
  import java.util.Collection;
  import java.util.List;
  import java.util.ListIterator;
  
  import net.sf.collections15.Predicate;
  import net.sf.collections15.collection.PredicatedCollection;
  import net.sf.collections15.iterators.AbstractListIteratorDecorator;
  
  
  /***
   * Decorates another <code>List</code> to validate that all additions
   * match a specified predicate.
   * <p>
   * This list exists to provide validation for the decorated list.
   * It is normally created to decorate an empty list.
   * If an object cannot be added to the list, an IllegalArgumentException is thrown.
   * <p>
   * One usage would be to ensure that no null entries are added to the list.
   * <pre>List<String> list =
   *        PredicatedList.<String>decorate(new ArrayList<String>(),
   *                                        NotNullPredicate.<String>getInstance());</pre>
   * <p>
   * This class is Serializable from Commons Collections 3.1.
   *
   * @since Commons Collections 3.0
   * @version $Revision: 1.2 $ $Date: 2005/05/25 21:25:25 $
   * 
   * @author Stephen Colebourne
   * @author Paul Jack
   */
  public class PredicatedList<E> extends PredicatedCollection<E> implements List<E> {
  
      /*** Serialization version */
  	private static final long serialVersionUID = 3256441391449258296L;
  
  	/***
       * Factory method to create a predicated (validating) list.
       * <p>
       * If there are any elements already in the list being decorated, they
       * are validated.
       * 
       * @param list  the list to decorate, must not be null
       * @param predicate  the predicate to use for validation, must not be null
       * @throws IllegalArgumentException if list or predicate is null
       * @throws IllegalArgumentException if the list contains invalid elements
       */
      public static <T> List<T> decorate(List<T> list, Predicate<? super T> predicate) {
          return new PredicatedList<T>(list, predicate);
      }
  
      //-----------------------------------------------------------------------
      /***
       * Constructor that wraps (not copies).
       * <p>
       * If there are any elements already in the list being decorated, they
       * are validated.
       * 
       * @param list  the list to decorate, must not be null
       * @param predicate  the predicate to use for validation, must not be null
       * @throws IllegalArgumentException if list or predicate is null
       * @throws IllegalArgumentException if the list contains invalid elements
       */
      protected PredicatedList(List<E> list, Predicate<? super E> predicate) {
          super(list, predicate);
      }
  
      /***
       * Gets the list being decorated.
       * 
       * @return the decorated list
       */
      protected List<E> getList() {
          return (List<E>) getCollection();
      }
  
      //-----------------------------------------------------------------------
      public E get(int index) {
          return getList().get(index);
      }
  
      public int indexOf(Object object) {
          return getList().indexOf(object);
     }
 
     public int lastIndexOf(Object object) {
         return getList().lastIndexOf(object);
     }
 
     public E remove(int index) {
         return getList().remove(index);
     }
 
     //-----------------------------------------------------------------------
     public void add(int index, E object) {
         validate(object);
         getList().add(index, object);
     }
 
     public boolean addAll(int index, Collection<? extends E> coll) {
         for( E object : coll ) {
             validate(object);
         }
         return getList().addAll(index, coll);
     }
 
     public ListIterator<E> listIterator() {
         return listIterator(0);
     }
 
     public ListIterator<E> listIterator(int i) {
         return new PredicatedListIterator(getList().listIterator(i));
     }
 
     public E set(int index, E object) {
         validate(object);
         return getList().set(index, object);
     }
 
     public List<E> subList(int fromIndex, int toIndex) {
         List<E> sub = getList().subList(fromIndex, toIndex);
         return new PredicatedList<E>(sub, predicate);
     }
 
     /***
      * Inner class Iterator for the PredicatedList
      */
     protected class PredicatedListIterator extends AbstractListIteratorDecorator<E> {
         
         protected PredicatedListIterator(ListIterator<E> iterator) {
             super(iterator);
         }
         
         public void add(E object) {
 			validate(object);
             iterator.add(object);
         }
         
         public void set(E object) {
             validate(object);
             iterator.set(object);
         }
     }
 
 }