/*
    * 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.iterators;
  
  import static org.junit.jupiter.api.Assertions.assertNotSame;
  import static org.junit.jupiter.api.Assertions.assertSame;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.Collections;
  import java.util.Iterator;
  import java.util.List;
  
  import org.apache.commons.collections4.Unmodifiable;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  
  /**
   * Tests the UnmodifiableIterator.
   */
  public class UnmodifiableIteratorTest<E> extends AbstractIteratorTest<E> {
  
      protected String[] testArray = { "One", "Two", "Three" };
      protected List<E> testList;
  
      public UnmodifiableIteratorTest() {
          super(UnmodifiableIteratorTest.class.getSimpleName());
      }
  
      @Override
      public Iterator<E> makeEmptyIterator() {
          return UnmodifiableIterator.unmodifiableIterator(Collections.<E>emptyList().iterator());
      }
  
      @Override
      public Iterator<E> makeObject() {
          return UnmodifiableIterator.unmodifiableIterator(testList.iterator());
      }
  
      /**
       * {@inheritDoc}
       */
      @SuppressWarnings("unchecked")
      @BeforeEach
      protected void setUp() throws Exception {
          testList = new ArrayList<>(Arrays.asList((E[]) testArray));
      }
  
      @Override
      public boolean supportsRemove() {
          return false;
      }
  
      @Test
      public void testDecorateFactory() {
          Iterator<E> it = makeObject();
          assertSame(it, UnmodifiableIterator.unmodifiableIterator(it));
  
          it = testList.iterator();
          assertNotSame(it, UnmodifiableIterator.unmodifiableIterator(it));
  
          assertThrows(NullPointerException.class, () -> UnmodifiableIterator.unmodifiableIterator(null));
      }
  
      @Test
      public void testIterator() {
          assertTrue(makeEmptyIterator() instanceof Unmodifiable);
      }
  
  }