Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add UnmodifiableMapIterator 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131318 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-11-02 18:29:59 +00:00
parent b4f545f3f3
commit 623af3b79d
4 changed files with 642 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

135
src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java Normal file
View File

@ -0,0 +1,135 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java,v 1.1 2003/11/02 18:29:59 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-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
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.iterators;
import java.util.Map.Entry;
import org.apache.commons.collections.Unmodifiable;
import org.apache.commons.collections.pairs.UnmodifiableMapEntry;
/**
* Decorates a map iterator such that it cannot be modified.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/02 18:29:59 $
*
* @author Stephen Colebourne
*/
public final class UnmodifiableMapIterator implements MapIterator, Unmodifiable {
/** The iterator being decorated */
private MapIterator iterator;
//-----------------------------------------------------------------------
/**
* Decorates the specified iterator such that it cannot be modified.
*
* @param iterator the iterator to decoarate
* @throws IllegalArgumentException if the iterator is null
*/
public static MapIterator decorate(MapIterator iterator) {
if (iterator == null) {
throw new IllegalArgumentException("MapIterator must not be null");
}
if (iterator instanceof Unmodifiable) {
return iterator;
}
return new UnmodifiableMapIterator(iterator);
}
//-----------------------------------------------------------------------
/**
* Constructor.
*
* @param iterator the iterator to decoarate
*/
protected UnmodifiableMapIterator(MapIterator iterator) {
super();
this.iterator = iterator;
}
//-----------------------------------------------------------------------
public boolean hasNext() {
return iterator.hasNext();
}
public Object next() {
return iterator.next();
}
public Object getKey() {
return iterator.getKey();
}
public Object getValue() {
return iterator.getValue();
}
public Entry asMapEntry() {
return new UnmodifiableMapEntry(getKey(), getValue());
}
public Object setValue(Object value) {
throw new UnsupportedOperationException("setValue() is not supported");
}
public void remove() {
throw new UnsupportedOperationException("remove() is not supported");
}
}

375
src/test/org/apache/commons/collections/iterators/AbstractTestMapIterator.java Normal file
View File

@ -0,0 +1,375 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/iterators/AbstractTestMapIterator.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
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.iterators;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.Map.Entry;
/**
* Abstract class for testing the MapIterator interface.
* <p>
* 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) {}
}
}

5
src/test/org/apache/commons/collections/iterators/TestAll.java
View File

@ -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;
}

129
src/test/org/apache/commons/collections/iterators/TestUnmodifiableMapIterator.java Normal file
View File

@ -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
* <http://www.apache.org/>.
*
*/
package org.apache.commons.collections.iterators;
import java.util.Map;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.commons.collections.BidiMap;
import org.apache.commons.collections.DualHashBidiMap;
import org.apache.commons.collections.Unmodifiable;
/**
* Tests the UnmodifiableMapIterator.
*
* @version $Revision: 1.1 $ $Date: 2003/11/02 18:29:59 $
*
* @author Stephen Colebourne
*/
public class TestUnmodifiableMapIterator extends AbstractTestMapIterator {
public static Test suite() {
return new TestSuite(TestUnmodifiableMapIterator.class);
}
public TestUnmodifiableMapIterator(String testName) {
super(testName);
}
public MapIterator makeEmptyMapIterator() {
return UnmodifiableMapIterator.decorate(new DualHashBidiMap().mapIterator());
}
public MapIterator makeFullMapIterator() {
return UnmodifiableMapIterator.decorate(((BidiMap) getMap()).mapIterator());
}
protected Map getMap() {
Map testMap = new DualHashBidiMap();
testMap.put("A", "a");
testMap.put("B", "b");
testMap.put("C", "c");
return testMap;
}
public boolean supportsRemove() {
return false;
}
public boolean supportsSetValue() {
return false;
}
//-----------------------------------------------------------------------
public void testMapIterator() {
assertTrue(makeEmptyMapIterator() instanceof Unmodifiable);
}
public void testDecorateFactory() {
MapIterator it = makeFullMapIterator();
assertSame(it, UnmodifiableMapIterator.decorate(it));
it = ((BidiMap) getMap()).mapIterator() ;
assertTrue(it != UnmodifiableMapIterator.decorate(it));
try {
UnmodifiableMapIterator.decorate(null);
fail();
} catch (IllegalArgumentException ex) {}
}
}