Fixed previousIndex() and nextIndex() methods in ArrayListIterator and ObjectArrayListIterator to conform to ListIterator interface specification.

Modified ObjectArrayIterator constructor to throw ArrayOutOfBoundsException when start index is out of range (as advertised).
Added test cases to TestIteratorUtils.


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131203 13f79535-47bb-0310-9956-ffa450edef68

src/java/org/apache/commons/collections/iterators/ArrayListIterator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ArrayListIterator.java,v 1.4 2003/08/31 17:25:49 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ArrayListIterator.java,v 1.5 2003/09/29 03:56:12 psteitz Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -77,10 +77,11 @@ import java.util.NoSuchElementException;
  * @see java.util.ListIterator
  *
  * @since Commons Collections 2.2
- * @version $Revision: 1.4 $ $Date: 2003/08/31 17:25:49 $
+ * @version $Revision: 1.5 $ $Date: 2003/09/29 03:56:12 $
  *
  * @author <a href="mailto:neilotoole@users.sourceforge.net">Neil O'Toole</a>
  * @author Stephen Colebourne
+ * @author Phil Steitz
  */
 public class ArrayListIterator extends ArrayIterator implements ResetableListIterator {
 
@@ -192,7 +193,7 @@ public class ArrayListIterator extends ArrayIterator implements ResetableListIte
      * @return the index of the item to be retrieved next
      */
     public int nextIndex() {
-        return this.index;
+        return this.index - this.startIndex;
     }
 
     /**
@@ -201,7 +202,7 @@ public class ArrayListIterator extends ArrayIterator implements ResetableListIte
      * @return the index of the item to be retrieved next
      */
     public int previousIndex() {
-        return this.index - 1;
+        return this.index - this.startIndex - 1;
     }
 
     /**

src/java/org/apache/commons/collections/iterators/ObjectArrayIterator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ObjectArrayIterator.java,v 1.6 2003/08/31 17:25:49 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ObjectArrayIterator.java,v 1.7 2003/09/29 03:56:12 psteitz Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -60,7 +60,7 @@ package org.apache.commons.collections.iterators;
 import java.util.NoSuchElementException;
 
 /** 
- * An {@link Iterator Iterator} over an array of objects.
+ * An {@link Iterator} over an array of objects.
  * <p>
  * This iterator does not support {@link #remove}, as the object array cannot be
  * structurally modified.
@@ -69,13 +69,14 @@ import java.util.NoSuchElementException;
  * back to the start if required.
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.6 $ $Date: 2003/08/31 17:25:49 $
+ * @version $Revision: 1.7 $ $Date: 2003/09/29 03:56:12 $
  * 
  * @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
  * @author Mauricio S. Moura
  * @author <a href="mailto:mas@apache.org">Michael A. Smith</a>
  * @author <a href="mailto:neilotoole@users.sourceforge.net">Neil O'Toole</a>
  * @author Stephen Colebourne
+ * @author Phil Steitz
  */
 public class ObjectArrayIterator implements ResetableIterator {
 
@@ -141,6 +142,9 @@ public class ObjectArrayIterator implements ResetableIterator {
         if (end > array.length) {
             throw new ArrayIndexOutOfBoundsException("End index must not be greater than the array length");
         }
+        if (start > array.length) {
+            throw new ArrayIndexOutOfBoundsException("Start index must not be greater than the array length");
+        }
         if (end < start) {
             throw new IllegalArgumentException("End index must not be less than start index");
         }

src/java/org/apache/commons/collections/iterators/ObjectArrayListIterator.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ObjectArrayListIterator.java,v 1.6 2003/08/31 17:25:49 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ObjectArrayListIterator.java,v 1.7 2003/09/29 03:56:12 psteitz Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -60,7 +60,7 @@ package org.apache.commons.collections.iterators;
 import java.util.NoSuchElementException;
 
 /**
- * Implements a {@link ListIterator ListIterator} over an array of objects.
+ * Implements a {@link ListIterator} over an array of objects.
  * <p>
  * This iterator does not support {@link #add} or {@link #remove}, as the object array 
  * cannot be structurally modified. The {@link #set} method is supported however.
@@ -73,10 +73,11 @@ import java.util.NoSuchElementException;
  * @see java.util.ListIterator
  *
  * @since Commons Collections 3.0
- * @version $Revision: 1.6 $ $Date: 2003/08/31 17:25:49 $
+ * @version $Revision: 1.7 $ $Date: 2003/09/29 03:56:12 $
  * 
  * @author <a href="mailto:neilotoole@users.sourceforge.net">Neil O'Toole</a>
  * @author Stephen Colebourne
+ * @author Phil Steitz
  */
 public class ObjectArrayListIterator extends ObjectArrayIterator implements ResetableListIterator {
 
@@ -183,7 +184,7 @@ public class ObjectArrayListIterator extends ObjectArrayIterator implements Rese
      * @return the index of the item to be retrieved next
      */
     public int nextIndex() {
-        return this.index;
+        return this.index - this.startIndex;
     }
 
     /**
@@ -192,7 +193,7 @@ public class ObjectArrayListIterator extends ObjectArrayIterator implements Rese
      * @return the index of the item to be retrieved next
      */
     public int previousIndex() {
-        return this.index - 1;
+        return this.index - this.startIndex - 1;
     }
 
     /**

src/test/org/apache/commons/collections/TestIteratorUtils.java

@@ -1,5 +1,5 @@
 /*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/TestIteratorUtils.java,v 1.5 2003/08/31 17:28:43 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/TestIteratorUtils.java,v 1.6 2003/09/29 03:56:12 psteitz Exp $
  * ====================================================================
  *
  * The Apache Software License, Version 1.1
@@ -62,6 +62,7 @@ import java.util.Arrays;
 import java.util.Iterator;
 import java.util.List;
 import java.util.ListIterator;
+import java.util.NoSuchElementException;
 
 import junit.framework.Test;
 
@@ -111,6 +112,289 @@ public class TestIteratorUtils extends BulkTest {
         assertEquals(list, Arrays.asList(result));
     }
     
+    public void testArrayIterator() {
+        Object[] objArray = {"a", "b", "c"};
+        ResetableIterator iterator = IteratorUtils.arrayIterator(objArray);
+        assertTrue(iterator.next().equals("a"));
+        assertTrue(iterator.next().equals("b"));
+        iterator.reset();
+        assertTrue(iterator.next().equals("a"));
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(new Integer(0));
+            fail("Expecting IllegalArgumentException");
+        } catch (IllegalArgumentException ex) {
+                // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(null);
+            fail("Expecting NullPointerException");
+        } catch (NullPointerException ex) {
+                // expected
+        }
+        
+        iterator = IteratorUtils.arrayIterator(objArray, 1);
+        assertTrue(iterator.next().equals("b"));
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(objArray, -1);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayIterator(objArray, 3);
+        assertTrue(!iterator.hasNext());
+        iterator.reset();
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(objArray, 4);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayIterator(objArray, 2, 3);
+        assertTrue(iterator.next().equals("c"));
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(objArray, 2, 4);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(objArray, -1, 1);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(objArray, 2, 1);
+            fail("Expecting IllegalArgumentException");
+        } catch (IllegalArgumentException ex) {
+            // expected
+        }
+        
+        int[] intArray = {0, 1, 2};
+        iterator = IteratorUtils.arrayIterator(intArray);
+        assertTrue(iterator.next().equals(new Integer(0)));
+        assertTrue(iterator.next().equals(new Integer(1)));
+        iterator.reset();
+        assertTrue(iterator.next().equals(new Integer(0)));
+        
+        iterator = IteratorUtils.arrayIterator(intArray, 1);
+        assertTrue(iterator.next().equals(new Integer(1)));
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(intArray, -1);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayIterator(intArray, 3);
+        assertTrue(!iterator.hasNext());
+        iterator.reset();
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(intArray, 4);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayIterator(intArray, 2, 3);
+        assertTrue(iterator.next().equals(new Integer(2)));
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(intArray, 2, 4);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(intArray, -1, 1);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayIterator(intArray, 2, 1);
+            fail("Expecting IllegalArgumentException");
+        } catch (IllegalArgumentException ex) {
+            // expected
+        }          
+    }
+    
+    public void testArrayListIterator() {
+        Object[] objArray = {"a", "b", "c", "d"};
+        ResetableListIterator iterator = IteratorUtils.arrayListIterator(objArray);
+        assertTrue(!iterator.hasPrevious());
+        assertTrue(iterator.previousIndex() == -1);
+        assertTrue(iterator.nextIndex() == 0);
+        assertTrue(iterator.next().equals("a"));
+        assertTrue(iterator.previous().equals("a"));
+        assertTrue(iterator.next().equals("a"));
+        assertTrue(iterator.previousIndex() == 0);
+        assertTrue(iterator.nextIndex() == 1);
+        assertTrue(iterator.next().equals("b"));
+        assertTrue(iterator.next().equals("c"));
+        assertTrue(iterator.next().equals("d"));
+        assertTrue(iterator.nextIndex() == 4); // size of list
+        assertTrue(iterator.previousIndex() == 3);
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(new Integer(0));
+            fail("Expecting IllegalArgumentException");
+        } catch (IllegalArgumentException ex) {
+                // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(null);
+            fail("Expecting NullPointerException");
+        } catch (NullPointerException ex) {
+                // expected
+        }
+        
+        iterator = IteratorUtils.arrayListIterator(objArray, 1);
+        assertTrue(iterator.previousIndex() == -1); 
+        assertTrue(!iterator.hasPrevious());
+        assertTrue(iterator.nextIndex() == 0); 
+        assertTrue(iterator.next().equals("b"));
+        assertTrue(iterator.previousIndex() == 0);        
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(objArray, -1);
+            fail("Expecting IndexOutOfBoundsException.");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayListIterator(objArray, 3);
+        assertTrue(iterator.hasNext());
+        try {
+            Object x = iterator.previous();
+            fail("Expecting NoSuchElementException.");
+        } catch (NoSuchElementException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(objArray, 5);
+            fail("Expecting IndexOutOfBoundsException.");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayListIterator(objArray, 2, 3);
+        assertTrue(iterator.next().equals("c"));
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(objArray, 2, 5);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(objArray, -1, 1);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(objArray, 2, 1);
+            fail("Expecting IllegalArgumentException");
+        } catch (IllegalArgumentException ex) {
+            // expected
+        }
+        
+        int[] intArray = {0, 1, 2};
+        iterator = IteratorUtils.arrayListIterator(intArray);
+        assertTrue(iterator.previousIndex() == -1); 
+        assertTrue(!iterator.hasPrevious());
+        assertTrue(iterator.nextIndex() == 0); 
+        assertTrue(iterator.next().equals(new Integer(0)));
+        assertTrue(iterator.previousIndex() == 0); 
+        assertTrue(iterator.nextIndex() == 1); 
+        assertTrue(iterator.next().equals(new Integer(1)));
+        assertTrue(iterator.previousIndex() == 1); 
+        assertTrue(iterator.nextIndex() == 2); 
+        assertTrue(iterator.previous().equals(new Integer(1)));
+        assertTrue(iterator.next().equals(new Integer(1)));
+        
+        iterator = IteratorUtils.arrayListIterator(intArray, 1);
+        assertTrue(iterator.previousIndex() == -1); 
+        assertTrue(!iterator.hasPrevious());
+        assertTrue(iterator.nextIndex() == 0); 
+        assertTrue(iterator.next().equals(new Integer(1)));
+        assertTrue(iterator.previous().equals(new Integer(1)));
+        assertTrue(iterator.next().equals(new Integer(1)));
+        assertTrue(iterator.previousIndex() == 0); 
+        assertTrue(iterator.nextIndex() == 1); 
+        assertTrue(iterator.next().equals(new Integer(2)));
+        assertTrue(iterator.previousIndex() == 1); 
+        assertTrue(iterator.nextIndex() == 2); 
+        assertTrue(iterator.previous().equals(new Integer(2)));
+        assertTrue(iterator.previousIndex() == 0); 
+        assertTrue(iterator.nextIndex() == 1); 
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(intArray, -1);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayListIterator(intArray, 3);
+        assertTrue(!iterator.hasNext());
+     
+        try {
+            iterator = IteratorUtils.arrayListIterator(intArray, 4);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        iterator = IteratorUtils.arrayListIterator(intArray, 2, 3);
+        assertTrue(!iterator.hasPrevious());
+        assertTrue(iterator.previousIndex() == -1);
+        assertTrue(iterator.next().equals(new Integer(2)));
+        assertTrue(iterator.hasPrevious());
+        assertTrue(!iterator.hasNext());
+        
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(intArray, 2, 4);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(intArray, -1, 1);
+            fail("Expecting IndexOutOfBoundsException");
+        } catch (IndexOutOfBoundsException ex) {
+            // expected
+        }
+        
+        try {
+            iterator = IteratorUtils.arrayListIterator(intArray, 2, 1);
+            fail("Expecting IllegalArgumentException");
+        } catch (IllegalArgumentException ex) {
+            // expected
+        }          
+    }
+        
+
     /**
      * Gets an immutable Iterator operating on the elements ["a", "b", "c", "d"].
      */