Add Flat3Map, a new map design for small Maps that is faster than HashMap

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

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

@@ -0,0 +1,214 @@
+/*
+ * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/test/org/apache/commons/collections/Attic/TestFlat3Map.java,v 1.1 2003/11/02 23:41:46 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;
+
+import java.util.Map;
+
+import junit.framework.Test;
+import junit.textui.TestRunner;
+
+import org.apache.commons.collections.iterators.AbstractTestMapIterator;
+import org.apache.commons.collections.iterators.MapIterator;
+
+/**
+ * JUnit tests.
+ * 
+ * @version $Revision: 1.1 $ $Date: 2003/11/02 23:41:46 $
+ * 
+ * @author Stephen Colebourne
+ */
+public class TestFlat3Map extends AbstractTestMap {
+
+    public TestFlat3Map(String testName) {
+        super(testName);
+    }
+
+    public static void main(String[] args) {
+        TestRunner.run(suite());
+    }
+    
+    public static Test suite() {
+        return BulkTest.makeSuite(TestFlat3Map.class);
+    }
+
+    protected Map makeEmptyMap() {
+        return new Flat3Map();
+    }
+
+    //-----------------------------------------------------------------------
+    public BulkTest bulkTestMapIterator() {
+        return new TestFlatMapIterator();
+    }
+    
+    public class TestFlatMapIterator extends AbstractTestMapIterator {
+        public TestFlatMapIterator() {
+            super("TestFlatMapIterator");
+        }
+        
+        protected Object addSetValue() {
+            return TestFlat3Map.this.getNewSampleValues()[0];
+        }
+        
+        protected boolean supportsRemove() {
+            return TestFlat3Map.this.isRemoveSupported();
+        }
+
+        protected boolean supportsSetValue() {
+            return TestFlat3Map.this.isSetValueSupported();
+        }
+
+        protected MapIterator makeEmptyMapIterator() {
+            resetEmpty();
+            return ((Flat3Map) TestFlat3Map.this.map).mapIterator();
+        }
+
+        protected MapIterator makeFullMapIterator() {
+            resetFull();
+            return ((Flat3Map) TestFlat3Map.this.map).mapIterator();
+        }
+        
+        protected Map getMap() {
+            // assumes makeFullMapIterator() called first
+            return TestFlat3Map.this.map;
+        }
+        
+        protected void verify() {
+            super.verify();
+            // cannot cross verify as we don't know what superclass did
+        }
+    }
+    
+    //-----------------------------------------------------------------------
+    public void testMapIteratorRemove() {
+        resetFull();
+        Flat3Map testMap = (Flat3Map) map;
+        MapIterator it = testMap.mapIterator();
+        assertEquals(true, it.hasNext());
+        Object key = it.next();
+        
+        if (isRemoveSupported() == false) {
+            try {
+                it.remove();
+                fail();
+            } catch (UnsupportedOperationException ex) {
+            }
+            return;
+        }
+        
+        it.remove();
+        confirmed.remove(key);
+        assertEquals(false, testMap.containsKey(key));
+        verify();
+        
+        try {
+            it.remove();  // second remove fails
+        } catch (IllegalStateException ex) {
+        }
+        verify();
+    }
+
+    //-----------------------------------------------------------------------
+    public void testMapIteratorSet() {
+        Object newValue1 = getOtherValues()[0];
+        Object newValue2 = getOtherValues()[1];
+        
+        resetFull();
+        Flat3Map testMap = (Flat3Map) map;
+        MapIterator it = testMap.mapIterator();
+        assertEquals(true, it.hasNext());
+        Object key1 = it.next();
+        
+        if (isSetValueSupported() == false) {
+            try {
+                it.setValue(newValue1);
+                fail();
+            } catch (UnsupportedOperationException ex) {
+            }
+            return;
+        }
+        
+        it.setValue(newValue1);
+        confirmed.put(key1, newValue1);
+        assertSame(key1, it.getKey());
+        assertSame(newValue1, it.getValue());
+        assertEquals(true, testMap.containsKey(key1));
+        assertEquals(true, testMap.containsValue(newValue1));
+        assertEquals(newValue1, testMap.get(key1));
+        verify();
+        
+        it.setValue(newValue1);  // same value - should be OK
+        confirmed.put(key1, newValue1);
+        assertSame(key1, it.getKey());
+        assertSame(newValue1, it.getValue());
+        assertEquals(true, testMap.containsKey(key1));
+        assertEquals(true, testMap.containsValue(newValue1));
+        assertEquals(newValue1, testMap.get(key1));
+        verify();
+        
+        Object key2 = it.next();
+        it.setValue(newValue2);
+        confirmed.put(key2, newValue2);
+        assertSame(key2, it.getKey());
+        assertSame(newValue2, it.getValue());
+        assertEquals(true, testMap.containsKey(key2));
+        assertEquals(true, testMap.containsValue(newValue2));
+        assertEquals(newValue2, testMap.get(key2));
+        verify();
+    }
+
+}