Added Mauricio S. Moura's patch to ArrayIterator such that next() calls move the iterator along rather than calls to hasNext(). I've also added a JUnit test case to demonstrate it in action and validate that it works correctly.

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@130481 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
James Strachan 2001-05-14 10:42:53 +00:00
parent 8ab1fd1633
commit 284b6f5477
3 changed files with 168 additions and 58 deletions

View File

@ -1,54 +1,55 @@
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE file.
*/
package org.apache.commons.collections;
import java.util.Iterator;
/** Implements {@link Iterator} over an array of objects
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
* @version $Revision: 1.1 $
*/
public class ArrayIterator implements Iterator {
private Object[] array;
private int index = -1;
public ArrayIterator() {
}
public ArrayIterator(Object[] array) {
this.array = array;
}
// Iterator interface
//-------------------------------------------------------------------------
public boolean hasNext() {
return ++index >= 0 && index < array.length;
}
public Object next() {
return array[ index ];
}
public void remove() {
throw new UnsupportedOperationException( "remove() method is not supported" );
}
// Properties
//-------------------------------------------------------------------------
public Object[] getArray() {
return array;
}
public void setArray( Object[] array ) {
this.array = array;
this.index = -1;
}
}
/*
* Copyright (C) The Apache Software Foundation. All rights reserved.
*
* This software is published under the terms of the Apache Software License
* version 1.1, a copy of which has been included with this distribution in
* the LICENSE file.
*/
package org.apache.commons.collections;
import java.util.Iterator;
/** Implements {@link Iterator} over an array of objects
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
* @
* @version $Revision: 1.2 $
*/
public class ArrayIterator implements Iterator {
private Object[] array;
private int index = 0;
public ArrayIterator() {
}
public ArrayIterator(Object[] array) {
this.array = array;
}
// Iterator interface
//-------------------------------------------------------------------------
public boolean hasNext() {
return (index < array.length);
}
public Object next() {
return array[ index++ ];
}
public void remove() {
throw new UnsupportedOperationException( "remove() method is not supported" );
}
// Properties
//-------------------------------------------------------------------------
public Object[] getArray() {
return array;
}
public void setArray( Object[] array ) {
this.array = array;
this.index = -1;
}
}

View File

@ -1,7 +1,7 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/TestAll.java,v 1.7 2001/05/04 02:23:44 geirm Exp $
* $Revision: 1.7 $
* $Date: 2001/05/04 02:23:44 $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/TestAll.java,v 1.8 2001/05/14 10:42:51 jstrachan Exp $
* $Revision: 1.8 $
* $Date: 2001/05/14 10:42:51 $
*
* ====================================================================
*
@ -66,7 +66,7 @@ import junit.framework.*;
/**
* Entry point for all Collections tests.
* @author Rodney Waldhoff
* @version $Id: TestAll.java,v 1.7 2001/05/04 02:23:44 geirm Exp $
* @version $Id: TestAll.java,v 1.8 2001/05/14 10:42:51 jstrachan Exp $
*/
public class TestAll extends TestCase {
public TestAll(String testName) {
@ -75,6 +75,7 @@ public class TestAll extends TestCase {
public static Test suite() {
TestSuite suite = new TestSuite();
suite.addTest(TestArrayIterator.suite());
suite.addTest(TestArrayList.suite());
suite.addTest(TestArrayStack.suite());
suite.addTest(TestCursorableLinkedList.suite());

View File

@ -0,0 +1,108 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/TestArrayIterator.java,v 1.1 2001/05/14 10:42:53 jstrachan Exp $
* $Revision: 1.1 $
* $Date: 2001/05/14 10:42:53 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections;
import junit.framework.*;
import java.util.Iterator;
/**
* Tests the ArrayIterator to ensure that the next() method will actually
* perform the iteration rather than the hasNext() method.
* The code of this test was supplied by Mauricio S. Moura
*
* @author James Strachan
* @author Mauricio S. Moura
* @version $Id: TestArrayIterator.java,v 1.1 2001/05/14 10:42:53 jstrachan Exp $
*/
public class TestArrayIterator extends TestObject {
protected String[] testArray = {
"One", "Two", "Three"
};
public static Test suite() {
return new TestSuite(TestArrayIterator.class);
}
public TestArrayIterator(String testName) {
super(testName);
}
/**
* Return a new, empty {@link Object} to used for testing.
*/
public Object makeObject() {
return new ArrayIterator(testArray);
}
public void testIterator() {
Iterator iter = (Iterator) makeObject();
for ( int i = 0; i < testArray.length; i++ ) {
Object testValue = testArray[i];
Object iterValue = iter.next();
assertEquals( "Iteration value is correct", testValue, iterValue );
}
assert("Iterator should now be empty", ! iter.hasNext() );
}
}