/*
    * 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.easymock.EasyMock.createMock;
  import static org.easymock.EasyMock.expect;
  import static org.easymock.EasyMock.replay;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  
  import java.util.Iterator;
  
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  import org.w3c.dom.Element;
  import org.w3c.dom.Node;
  import org.w3c.dom.NodeList;
  import org.w3c.dom.Text;
  
  /**
   * Tests the NodeListIterator.
   */
  public class NodeListIteratorTest extends AbstractIteratorTest<Node> {
  
      // Node array to be filled with mocked Node instances
      private Node[] nodes;
  
      // NodeListIterator supports two constructors. This flag allows to
      // control, which constructor to use in makeObject() and makeEmptyIterator
      private boolean createIteratorWithStandardConstr = true;
  
      /**
       * Junit Constructor
       */
      public NodeListIteratorTest() {
          super(NodeListIteratorTest.class.getSimpleName());
      }
  
      @Override
      public Iterator<Node> makeEmptyIterator() {
          final NodeList emptyNodeList = new NodeList() {
              @Override
              public int getLength() {
                  return 0;
              }
              @Override
              public Node item(final int index) {
                  throw new IndexOutOfBoundsException();
              }
          };
  
          if (createIteratorWithStandardConstr) {
              return new NodeListIterator(emptyNodeList);
          }
          final Node parentNode = createMock(Node.class);
          expect(parentNode.getChildNodes()).andStubReturn(emptyNodeList);
          replay(parentNode);
  
          return new NodeListIterator(parentNode);
      }
  
      @Override
      public Iterator<Node> makeObject() {
          final NodeList nodeList = new NodeList() {
              @Override
              public int getLength() {
                  return nodes.length;
              }
              @Override
              public Node item(final int index) {
                  return nodes[index];
              }
          };
  
          return new NodeListIterator(nodeList);
      }
  
      @BeforeEach
      protected void setUp() throws Exception {
  
          // Default: use standard constr.
          createIteratorWithStandardConstr = true;
  
          // create mocked Node Instances and fill Node[] to be used by test cases
          final Node node1 = createMock(Element.class);
          final Node node2 = createMock(Element.class);
         final Node node3 = createMock(Text.class);
         final Node node4 = createMock(Element.class);
         nodes = new Node[] {node1, node2, node3, node4};
 
         replay(node1);
         replay(node2);
         replay(node3);
         replay(node4);
     }
 
     @Override
     public boolean supportsRemove() {
         return false;
     }
 
     /**
      * tests the convenience Constructor with parameter type org.w3c.Node
      */
     @Test
     public void testEmptyIteratorWithNodeConstructor(){
         createIteratorWithStandardConstr = false;
         testEmptyIterator();
     }
 
     /**
      * tests the convenience Constructor with parameter type org.w3c.Node
      */
     @Test
     public void testFullIteratorWithNodeConstructor(){
         createIteratorWithStandardConstr = false;
         testFullIterator();
     }
 
     @Test
     public void testNullConstructor() {
         assertThrows(NullPointerException.class, () -> new NodeListIterator((Node) null));
     }
 
 }