+ * This class provides a framework for testing an implementation of MapIterator.
+ * Concrete subclasses must provide the list iterator to be tested.
+ * They must also specify certain details of how the list iterator operates by
+ * overriding the supportsXxx() methods if necessary.
+ *
+ * @since Commons Collections 3.0
+ * @version $Revision: 1.1 $ $Date: 2003/11/02 18:29:59 $
+ *
+ * @author Stephen Colebourne
+ */
+public abstract class AbstractTestMapIterator extends AbstractTestIterator {
+
+ /**
+ * JUnit constructor.
+ *
+ * @param testName the test class name
+ */
+ public AbstractTestMapIterator(String testName) {
+ super(testName);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Implement this method to return a map iterator over an empty map.
+ *
+ * @return an empty iterator
+ */
+ protected abstract MapIterator makeEmptyMapIterator();
+
+ /**
+ * Implement this method to return a map iterator over a map with elements.
+ *
+ * @return a full iterator
+ */
+ protected abstract MapIterator makeFullMapIterator();
+
+ /**
+ * Implement this method to return the map which contains the same data as the
+ * iterator.
+ *
+ * @return a full map which can be updated
+ */
+ protected abstract Map getMap();
+
+ /**
+ * Override if the map returned by getMap() is NOT the one tied to the iterator.
+ *
+ * @return true if the getMap() map is the one tied to the iterator
+ */
+ protected boolean supportsTiedMap() {
+ return true;
+ }
+
+ /**
+ * Implements the abstract superclass method to return the list iterator.
+ *
+ * @return an empty iterator
+ */
+ protected final Iterator makeEmptyIterator() {
+ return makeEmptyMapIterator();
+ }
+
+ /**
+ * Implements the abstract superclass method to return the list iterator.
+ *
+ * @return a full iterator
+ */
+ protected final Iterator makeFullIterator() {
+ return makeFullMapIterator();
+ }
+
+ /**
+ * Whether or not we are testing an iterator that supports setValue().
+ * Default is true.
+ *
+ * @return true if Iterator supports set
+ */
+ protected boolean supportsSetValue() {
+ return true;
+ }
+
+ /**
+ * The value to be used in the add and set tests.
+ * Default is null.
+ */
+ protected Object addSetValue() {
+ return null;
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Test that the empty list iterator contract is correct.
+ */
+ public void testEmptyMapIterator() {
+ if (supportsEmptyIterator() == false) {
+ return;
+ }
+
+ MapIterator it = makeEmptyMapIterator();
+ assertEquals(false, it.hasNext());
+
+ // next() should throw a NoSuchElementException
+ try {
+ it.next();
+ fail();
+ } catch (NoSuchElementException ex) {}
+
+ // getKey() should throw an IllegalStateException
+ try {
+ it.getKey();
+ fail();
+ } catch (IllegalStateException ex) {}
+
+ // getValue() should throw an IllegalStateException
+ try {
+ it.getValue();
+ fail();
+ } catch (IllegalStateException ex) {}
+
+ // asMapEntry() should throw an IllegalStateException
+ try {
+ it.asMapEntry();
+ fail();
+ } catch (IllegalStateException ex) {}
+
+ if (supportsSetValue() == false) {
+ // setValue() should throw an UnsupportedOperationException/IllegalStateException
+ try {
+ it.setValue(addSetValue());
+ fail();
+ } catch (UnsupportedOperationException ex) {
+ } catch (IllegalStateException ex) {}
+ } else {
+ // setValue() should throw an IllegalStateException
+ try {
+ it.setValue(addSetValue());
+ fail();
+ } catch (IllegalStateException ex) {}
+ }
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * Test that the full list iterator contract is correct.
+ */
+ public void testFullMapIterator() {
+ if (supportsFullIterator() == false) {
+ return;
+ }
+
+ MapIterator it = makeFullMapIterator();
+ Map map = getMap();
+ assertEquals(true, it.hasNext());
+
+ assertEquals(true, it.hasNext());
+ Map.Entry lastEntry = null;
+ Object lastKey = null;
+ Object lastValue = null;
+ Set set = new HashSet();
+ while (it.hasNext()) {
+ // getKey
+ Object key = it.next();
+ assertSame("it.next() should equals getKey()", key, it.getKey());
+ assertTrue("Key must be in map", map.containsKey(key));
+ assertTrue("Key must be unique", set.add(key));
+
+ // getValue
+ Object value = it.getValue();
+ assertSame("Value must be mapped to key", map.get(key), value);
+ assertTrue("Value must be in map", map.containsValue(value));
+ assertSame("Value must be mapped to key", map.get(key), value);
+
+ // asMapEntry
+ Map.Entry entry = it.asMapEntry();
+ assertSame("MapEntry key must match", key, entry.getKey());
+ assertSame("MapEntry value must match", value, entry.getValue());
+
+ assertTrue("MapEntry must be independent", entry != lastEntry);
+ if (lastKey != null && lastValue != null) {
+ assertSame("MapEntry must not change after next()", lastKey, lastEntry.getKey());
+ assertSame("MapEntry must not change after next()", lastValue, lastEntry.getValue());
+ }
+
+ lastEntry = entry;
+ lastKey = key;
+ lastValue = value;
+ }
+ }
+
+ //-----------------------------------------------------------------------
+ public void testMapIteratorSet() {
+ if (supportsFullIterator() == false) {
+ return;
+ }
+
+ Object newValue = addSetValue();
+ MapIterator it = makeFullMapIterator();
+ Map map = getMap();
+ assertEquals(true, it.hasNext());
+ Object key = it.next();
+ Object value = it.getValue();
+ Entry entry = it.asMapEntry();
+
+ if (supportsSetValue() == false) {
+ try {
+ it.setValue(newValue);
+ fail();
+ } catch (UnsupportedOperationException ex) {}
+ return;
+ }
+
+ Object old = it.setValue(newValue);
+ assertSame("Key must not change after setValue", key, it.getKey());
+ assertSame("Key must not change after setValue", key, entry.getKey());
+ assertSame("Value must be changed after setValue", newValue, it.getValue());
+ assertSame("Value must be changed after setValue", newValue, entry.getValue());
+ assertSame("setValue must return old value", value, old);
+ if (supportsTiedMap()) {
+ assertTrue("Key must be in map", map.containsKey(key));
+ assertTrue("Old value must not be in map", map.containsValue(value) == false);
+ assertTrue("Value must be in map", map.containsValue(newValue));
+ assertSame("Value must be mapped to key", map.get(key), newValue);
+ }
+
+ it.setValue(newValue); // same value - should be OK
+ assertSame("Key must not change after setValue", key, it.getKey());
+ assertSame("Key must not change after setValue", key, entry.getKey());
+ assertSame("Value must be changed after setValue", newValue, it.getValue());
+ assertSame("Value must be changed after setValue", newValue, entry.getValue());
+ if (supportsTiedMap()) {
+ assertTrue("Key must be in map", map.containsKey(key));
+ assertTrue("Old value must not be in map", map.containsValue(value) == false);
+ assertTrue("Value must be in map", map.containsValue(newValue));
+ assertSame("Value must be mapped to key", map.get(key), newValue);
+ }
+ }
+
+ //-----------------------------------------------------------------------
+ public void testMapIteratorMapEntrySet() {
+ if (supportsFullIterator() == false) {
+ return;
+ }
+
+ Object newValue = addSetValue();
+ MapIterator it = makeFullMapIterator();
+ Map map = getMap();
+ assertEquals(true, it.hasNext());
+ Object key = it.next();
+ Object value = it.getValue();
+ Entry entry = it.asMapEntry();
+
+ if (supportsSetValue() == false) {
+ try {
+ entry.setValue(newValue);
+ fail();
+ } catch (UnsupportedOperationException ex) {}
+ return;
+ }
+
+ Object old = entry.setValue(newValue);
+ assertSame("Key must not change after setValue", key, it.getKey());
+ assertSame("Key must not change after setValue", key, entry.getKey());
+ assertSame("Value must be changed after setValue", newValue, it.getValue());
+ assertSame("Value must be changed after setValue", newValue, entry.getValue());
+ assertSame("setValue must return old value", value, old);
+ if (supportsTiedMap()) {
+ assertTrue("Key must be in map", map.containsKey(key));
+ assertTrue("Old value must not be in map", map.containsValue(value) == false);
+ assertTrue("Value must be in map", map.containsValue(newValue));
+ assertSame("Value must be mapped to key", map.get(key), newValue);
+ }
+
+ entry.setValue(newValue); // same value - should be OK
+ assertSame("Key must not change after setValue", key, it.getKey());
+ assertSame("Key must not change after setValue", key, entry.getKey());
+ assertSame("Value must be changed after setValue", newValue, it.getValue());
+ assertSame("Value must be changed after setValue", newValue, entry.getValue());
+ if (supportsTiedMap()) {
+ assertTrue("Key must be in map", map.containsKey(key));
+ assertTrue("Old value must not be in map", map.containsValue(value) == false);
+ assertTrue("Value must be in map", map.containsValue(newValue));
+ assertSame("Value must be mapped to key", map.get(key), newValue);
+ }
+ }
+
+ //-----------------------------------------------------------------------
+ public void testBidiMapIteratorSetRemoveSet() {
+ if (supportsSetValue() == false || supportsRemove() == false) {
+ return;
+ }
+ Object newValue = addSetValue();
+
+ MapIterator it = makeFullMapIterator();
+ assertEquals(true, it.hasNext());
+ Object key = it.next();
+
+ it.setValue(newValue);
+ it.remove();
+
+ try {
+ it.setValue(newValue);
+ fail();
+ } catch (IllegalStateException ex) {}
+ }
+
+}
diff --git a/src/test/org/apache/commons/collections/iterators/TestAll.java b/src/test/org/apache/commons/collections/iterators/TestAll.java
index fbaabd0dd..e938d2364 100644
--- a/src/test/org/apache/commons/collections/iterators/TestAll.java
+++ b/src/test/org/apache/commons/collections/iterators/TestAll.java
@@ -1,5 +1,5 @@
/*
- * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/iterators/TestAll.java,v 1.8 2003/11/02 17:26:36 scolebourne Exp $
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/iterators/TestAll.java,v 1.9 2003/11/02 18:29:59 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@@ -64,7 +64,7 @@ import junit.framework.TestSuite;
/**
* Entry point for all iterator tests.
*
- * @version $Revision: 1.8 $ $Date: 2003/11/02 17:26:36 $
+ * @version $Revision: 1.9 $ $Date: 2003/11/02 18:29:59 $
*
* @author Rodney Waldhoff
*/
@@ -94,6 +94,7 @@ public class TestAll extends TestCase {
suite.addTest(TestUniqueFilterIterator.suite());
suite.addTest(TestUnmodifiableIterator.suite());
suite.addTest(TestUnmodifiableListIterator.suite());
+ suite.addTest(TestUnmodifiableMapIterator.suite());
return suite;
}
diff --git a/src/test/org/apache/commons/collections/iterators/TestUnmodifiableMapIterator.java b/src/test/org/apache/commons/collections/iterators/TestUnmodifiableMapIterator.java
new file mode 100644
index 000000000..01d0fbd4b
--- /dev/null
+++ b/src/test/org/apache/commons/collections/iterators/TestUnmodifiableMapIterator.java
@@ -0,0 +1,129 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/iterators/TestUnmodifiableMapIterator.java,v 1.1 2003/11/02 18:29:59 scolebourne Exp $
+ * ====================================================================
+ *
+ * The Apache Software License, Version 1.1
+ *
+ * Copyright (c) 2001-2003 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 acknowledgement:
+ * "This product includes software developed by the
+ * Apache Software Foundation (http://www.apache.org/)."
+ * Alternately, this acknowledgement may appear in the software itself,
+ * if and wherever such third-party acknowledgements 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 Software Foundation.
+ *
+ * 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
+ *