/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You 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 org.apache.commons.collections4.collection;
  
  import static org.junit.jupiter.api.Assertions.assertFalse;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.Collection;
  import java.util.List;
  
  import org.apache.commons.collections4.Predicate;
  import org.apache.commons.collections4.functors.TruePredicate;
  import org.junit.jupiter.api.Test;
  
  /**
   * Extension of {@link AbstractCollectionTest} for exercising the
   * {@link PredicatedCollection} implementation.
   */
  public class PredicatedCollectionTest<E> extends AbstractCollectionTest<E> {
  
      protected Predicate<E> truePredicate = TruePredicate.<E>truePredicate();
  
      protected Predicate<E> testPredicate =
          String.class::isInstance;
  
      protected Collection<E> decorateCollection(
                  final Collection<E> collection, final Predicate<E> predicate) {
          return PredicatedCollection.predicatedCollection(collection, predicate);
      }
  
      @Override
      public String getCompatibilityVersion() {
          return "4";
      }
  
      @Override
      @SuppressWarnings("unchecked")
      public E[] getFullElements() {
          return (E[]) new Object[] { "1", "3", "5", "7", "2", "4", "6" };
      }
  
      @Override
      public Collection<E> makeConfirmedCollection() {
          return new ArrayList<>();
      }
  
      @Override
      public Collection<E> makeConfirmedFullCollection() {
          return new ArrayList<>(Arrays.asList(getFullElements()));
      }
  
      @Override
      public Collection<E> makeFullCollection() {
          final List<E> list = new ArrayList<>(Arrays.asList(getFullElements()));
          return decorateCollection(list, truePredicate);
      }
  
      @Override
      public Collection<E> makeObject() {
          return decorateCollection(new ArrayList<>(), truePredicate);
      }
  
      public Collection<E> makeTestCollection() {
          return decorateCollection(new ArrayList<>(), testPredicate);
      }
  
      @Test
      @SuppressWarnings("unchecked")
      public void testIllegalAdd() {
          final Collection<E> c = makeTestCollection();
          final Integer i = 3;
  
          assertThrows(IllegalArgumentException.class, () -> c.add((E) i), "Integer should fail string predicate.");
  
          assertFalse(c.contains(i), "Collection shouldn't contain illegal element");
      }
  
      @Test
      @SuppressWarnings("unchecked")
      public void testIllegalAddAll() {
          final Collection<E> c = makeTestCollection();
          final List<E> elements = new ArrayList<>();
          elements.add((E) "one");
         elements.add((E) "two");
         elements.add((E) Integer.valueOf(3));
         elements.add((E) "four");
 
         assertThrows(IllegalArgumentException.class, () -> c.addAll(elements), "Integer should fail string predicate.");
 
         assertFalse(c.contains("one"), "Collection shouldn't contain illegal element");
         assertFalse(c.contains("two"), "Collection shouldn't contain illegal element");
         assertFalse(c.contains(3), "Collection shouldn't contain illegal element");
         assertFalse(c.contains("four"), "Collection shouldn't contain illegal element");
     }
 
 //    public void testCreate() throws Exception {
 //        resetEmpty();
 //        writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/PredicatedCollection.emptyCollection.version4.obj");
 //        resetFull();
 //        writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/PredicatedCollection.fullCollection.version4.obj");
 //    }
 
 }