src/testcases/org/apache/poi/util/TestShortList.java

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */
        

package org.apache.poi.util;

import junit.framework.*;

/**
 * Class to test ShortList
 *
 * @author Marc Johnson
 */

public class TestShortList
    extends TestCase
{

    /**
     * Constructor TestShortList
     *
     * @param name
     */

    public TestShortList(String name)
    {
        super(name);
    }

    /**
     * test the various ShortListconstructors
     */

    public void testConstructors()
    {
        ShortList list = new ShortList();

        assertTrue(list.isEmpty());
        list.add(( short ) 0);
        list.add(( short ) 1);
        ShortList list2 = new ShortList(list);

        assertEquals(list, list2);
        ShortList list3 = new ShortList(2);

        assertTrue(list3.isEmpty());
    }

    /**
     * test the add method
     */

    public void testAdd()
    {
        ShortList list      = new ShortList();
        short[]   testArray =
        {
            0, 1, 2, 3, 5
        };

        for (int j = 0; j < testArray.length; j++)
        {
            list.add(testArray[ j ]);
        }
        for (int j = 0; j < testArray.length; j++)
        {
            assertEquals(testArray[ j ], list.get(j));
        }
        assertEquals(testArray.length, list.size());

        // add at the beginning
        list.add(0, ( short ) -1);
        assertEquals(( short ) -1, list.get(0));
        assertEquals(testArray.length + 1, list.size());
        for (int j = 0; j < testArray.length; j++)
        {
            assertEquals(testArray[ j ], list.get(j + 1));
        }

        // add in the middle
        list.add(5, ( short ) 4);
        assertEquals(( short ) 4, list.get(5));
        assertEquals(testArray.length + 2, list.size());
        for (int j = 0; j < list.size(); j++)
        {
            assertEquals(( short ) (j - 1), list.get(j));
        }

        // add at the end
        list.add(list.size(), ( short ) 6);
        assertEquals(testArray.length + 3, list.size());
        for (int j = 0; j < list.size(); j++)
        {
            assertEquals(( short ) (j - 1), list.get(j));
        }

        // add past end
        try
        {
            list.add(list.size() + 1, ( short ) 8);
            fail("should have thrown exception");
        }
        catch (IndexOutOfBoundsException e)
        {

            // as expected
        }

        // test growth
        list = new ShortList(0);
        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        assertEquals(1000, list.size());
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(j, list.get(j));
        }
        list = new ShortList(0);
        for (short j = 0; j < 1000; j++)
        {
            list.add(0, j);
        }
        assertEquals(1000, list.size());
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(j, list.get(999 - j));
        }
    }

    /**
     * test the addAll method
     */

    public void testAddAll()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 5; j++)
        {
            list.add(j);
        }
        ShortList list2 = new ShortList(0);

        list2.addAll(list);
        list2.addAll(list);
        assertEquals(2 * list.size(), list2.size());
        for (short j = 0; j < 5; j++)
        {
            assertEquals(list2.get(j), j);
            assertEquals(list2.get(j + list.size()), j);
        }
        ShortList empty = new ShortList();
        int       limit = list.size();

        for (int j = 0; j < limit; j++)
        {
            assertTrue(list.addAll(j, empty));
            assertEquals(limit, list.size());
        }
        try
        {
            list.addAll(limit + 1, empty);
            fail("should have thrown an exception");
        }
        catch (IndexOutOfBoundsException e)
        {

            // as expected
        }

        // try add at beginning
        empty.addAll(0, list);
        assertEquals(empty, list);

        // try in the middle
        empty.addAll(1, list);
        assertEquals(2 * list.size(), empty.size());
        assertEquals(list.get(0), empty.get(0));
        assertEquals(list.get(0), empty.get(1));
        assertEquals(list.get(1), empty.get(2));
        assertEquals(list.get(1), empty.get(6));
        assertEquals(list.get(2), empty.get(3));
        assertEquals(list.get(2), empty.get(7));
        assertEquals(list.get(3), empty.get(4));
        assertEquals(list.get(3), empty.get(8));
        assertEquals(list.get(4), empty.get(5));
        assertEquals(list.get(4), empty.get(9));

        // try at the end
        empty.addAll(empty.size(), list);
        assertEquals(3 * list.size(), empty.size());
        assertEquals(list.get(0), empty.get(0));
        assertEquals(list.get(0), empty.get(1));
        assertEquals(list.get(0), empty.get(10));
        assertEquals(list.get(1), empty.get(2));
        assertEquals(list.get(1), empty.get(6));
        assertEquals(list.get(1), empty.get(11));
        assertEquals(list.get(2), empty.get(3));
        assertEquals(list.get(2), empty.get(7));
        assertEquals(list.get(2), empty.get(12));
        assertEquals(list.get(3), empty.get(4));
        assertEquals(list.get(3), empty.get(8));
        assertEquals(list.get(3), empty.get(13));
        assertEquals(list.get(4), empty.get(5));
        assertEquals(list.get(4), empty.get(9));
        assertEquals(list.get(4), empty.get(14));
    }

    /**
     * test the clear method
     */

    public void testClear()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 500; j++)
        {
            list.add(j);
        }
        assertEquals(500, list.size());
        list.clear();
        assertEquals(0, list.size());
        for (short j = 0; j < 500; j++)
        {
            list.add(( short ) (j + 1));
        }
        assertEquals(500, list.size());
        for (short j = 0; j < 500; j++)
        {
            assertEquals(j + 1, list.get(j));
        }
    }

    /**
     * test the contains method
     */

    public void testContains()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j += 2)
        {
            list.add(j);
        }
        for (short j = 0; j < 1000; j++)
        {
            if (j % 2 == 0)
            {
                assertTrue(list.contains(j));
            }
            else
            {
                assertTrue(!list.contains(j));
            }
        }
    }

    /**
     * test the containsAll method
     */

    public void testContainsAll()
    {
        ShortList list = new ShortList();

        assertTrue(list.containsAll(list));
        for (short j = 0; j < 10; j++)
        {
            list.add(j);
        }
        ShortList list2 = new ShortList(list);

        assertTrue(list2.containsAll(list));
        assertTrue(list.containsAll(list2));
        list2.add(( short ) 10);
        assertTrue(list2.containsAll(list));
        assertTrue(!list.containsAll(list2));
        list.add(( short ) 11);
        assertTrue(!list2.containsAll(list));
        assertTrue(!list.containsAll(list2));
    }

    /**
     * test the equals method
     */

    public void testEquals()
    {
        ShortList list = new ShortList();

        assertEquals(list, list);
        assertTrue(!list.equals(null));
        ShortList list2 = new ShortList(200);

        assertEquals(list, list2);
        assertEquals(list2, list);
        assertEquals(list.hashCode(), list2.hashCode());
        list.add(( short ) 0);
        list.add(( short ) 1);
        list2.add(( short ) 1);
        list2.add(( short ) 0);
        assertTrue(!list.equals(list2));
        list2.removeValue(( short ) 1);
        list2.add(( short ) 1);
        assertEquals(list, list2);
        assertEquals(list2, list);
        list2.add(( short ) 2);
        assertTrue(!list.equals(list2));
        assertTrue(!list2.equals(list));
    }

    /**
     * test the get method
     */

    public void testGet()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        for (short j = 0; j < 1001; j++)
        {
            try
            {
                assertEquals(j, list.get(j));
                if (j == 1000)
                {
                    fail("should have gotten exception");
                }
            }
            catch (IndexOutOfBoundsException e)
            {
                if (j != 1000)
                {
                    fail("unexpected IndexOutOfBoundsException");
                }
            }
        }
    }

    /**
     * test the indexOf method
     */

    public void testIndexOf()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(( short ) (j / 2));
        }
        for (short j = 0; j < 1000; j++)
        {
            if (j < 500)
            {
                assertEquals(j * 2, list.indexOf(j));
            }
            else
            {
                assertEquals(-1, list.indexOf(j));
            }
        }
    }

    /**
     * test the isEmpty method
     */

    public void testIsEmpty()
    {
        ShortList list1 = new ShortList();
        ShortList list2 = new ShortList(1000);
        ShortList list3 = new ShortList(list1);

        assertTrue(list1.isEmpty());
        assertTrue(list2.isEmpty());
        assertTrue(list3.isEmpty());
        list1.add(( short ) 1);
        list2.add(( short ) 2);
        list3 = new ShortList(list2);
        assertTrue(!list1.isEmpty());
        assertTrue(!list2.isEmpty());
        assertTrue(!list3.isEmpty());
        list1.clear();
        list2.remove(0);
        list3.removeValue(( short ) 2);
        assertTrue(list1.isEmpty());
        assertTrue(list2.isEmpty());
        assertTrue(list3.isEmpty());
    }

    /**
     * test the lastIndexOf method
     */

    public void testLastIndexOf()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(( short ) (j / 2));
        }
        for (short j = 0; j < 1000; j++)
        {
            if (j < 500)
            {
                assertEquals(1 + j * 2, list.lastIndexOf(j));
            }
            else
            {
                assertEquals(-1, list.indexOf(j));
            }
        }
    }

    /**
     * test the remove method
     */

    public void testRemove()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(j, list.remove(0));
            assertEquals(( short ) (999 - j), list.size());
        }
        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(( short ) (999 - j),
                         list.remove(( short ) (999 - j)));
            assertEquals(999 - j, list.size());
        }
        try
        {
            list.remove(0);
            fail("should have caught IndexOutOfBoundsException");
        }
        catch (IndexOutOfBoundsException e)
        {

            // as expected
        }
    }

    /**
     * test the removeValue method
     */

    public void testRemoveValue()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(( short ) (j / 2));
        }
        for (short j = 0; j < 1000; j++)
        {
            if (j < 500)
            {
                assertTrue(list.removeValue(j));
                assertTrue(list.removeValue(j));
            }
            assertTrue(!list.removeValue(j));
        }
    }

    /**
     * test the removeAll method
     */

    public void testRemoveAll()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        ShortList listCopy = new ShortList(list);
        ShortList listOdd  = new ShortList();
        ShortList listEven = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            if (j % 2 == 0)
            {
                listEven.add(j);
            }
            else
            {
                listOdd.add(j);
            }
        }
        list.removeAll(listEven);
        assertEquals(list, listOdd);
        list.removeAll(listOdd);
        assertTrue(list.isEmpty());
        listCopy.removeAll(listOdd);
        assertEquals(listCopy, listEven);
        listCopy.removeAll(listEven);
        assertTrue(listCopy.isEmpty());
    }

    /**
     * test the retainAll method
     */

    public void testRetainAll()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        ShortList listCopy = new ShortList(list);
        ShortList listOdd  = new ShortList();
        ShortList listEven = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            if (j % 2 == 0)
            {
                listEven.add(j);
            }
            else
            {
                listOdd.add(j);
            }
        }
        list.retainAll(listOdd);
        assertEquals(list, listOdd);
        list.retainAll(listEven);
        assertTrue(list.isEmpty());
        listCopy.retainAll(listEven);
        assertEquals(listCopy, listEven);
        listCopy.retainAll(listOdd);
        assertTrue(listCopy.isEmpty());
    }

    /**
     * test the set method
     */

    public void testSet()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        for (short j = 0; j < 1001; j++)
        {
            try
            {
                list.set(j, ( short ) (j + 1));
                if (j == 1000)
                {
                    fail("Should have gotten exception");
                }
                assertEquals(j + 1, list.get(j));
            }
            catch (IndexOutOfBoundsException e)
            {
                if (j != 1000)
                {
                    fail("premature exception");
                }
            }
        }
    }

    /**
     * test the size method
     */

    public void testSize()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            assertEquals(j, list.size());
            list.add(j);
            assertEquals(j + 1, list.size());
        }
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(1000 - j, list.size());
            list.removeValue(j);
            assertEquals(999 - j, list.size());
        }
    }

    /**
     * test the toArray method
     */

    public void testToArray()
    {
        ShortList list = new ShortList();

        for (short j = 0; j < 1000; j++)
        {
            list.add(j);
        }
        short[] a1 = list.toArray();

        assertEquals(a1.length, list.size());
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(a1[ j ], list.get(j));
        }
        short[] a2 = new short[ list.size() ];
        short[] a3 = list.toArray(a2);

        assertSame(a2, a3);
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(a2[ j ], list.get(j));
        }
        short[] aShort = new short[ list.size() - 1 ];
        short[] aLong  = new short[ list.size() + 1 ];
        short[] a4     = list.toArray(aShort);
        short[] a5     = list.toArray(aLong);

        assertTrue(a4 != aShort);
        assertTrue(a5 != aLong);
        assertEquals(a4.length, list.size());
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(a3[ j ], list.get(j));
        }
        assertEquals(a5.length, list.size());
        for (short j = 0; j < 1000; j++)
        {
            assertEquals(a5[ j ], list.get(j));
        }
    }

    /**
     * main method to run the unit tests
     *
     * @param unused_args
     */

    public static void main(String [] unused_args)
    {
        System.out.println("Testing util.ShortList functionality");
        junit.textui.TestRunner.run(TestShortList.class);
    }
}