Java Doc for AbstractTestMap.java in  » Library » Apache-common-Collections » org » apache » commons » collections » map » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The forces at work here are similar to those in AbstractTestCollection . If your class implements the full Map interface, including optional operations, simply extend this class, and implement the AbstractTestMap.makeEmptyMap() method.

On the other hand, if your map implementation is weird, you may have to override one or more of the other protected methods. They're described below.

Entry Population Methods

Override these methods if your map requires special entries:

• AbstractTestMap.getSampleKeys()
• AbstractTestMap.getSampleValues()
• AbstractTestMap.getNewSampleValues()
• AbstractTestMap.getOtherKeys()
• AbstractTestMap.getOtherValues()

Override these methods if your map doesn't support certain operations:

• AbstractTestMap.isPutAddSupported()
• AbstractTestMap.isPutChangeSupported()
• AbstractTestMap.isSetValueSupported()
• AbstractTestMap.isRemoveSupported()
• AbstractTestMap.isGetStructuralModify()
• AbstractTestMap.isAllowDuplicateValues()
• AbstractTestMap.isAllowNullKey()
• AbstractTestMap.isAllowNullValue()

For tests on modification operations (puts and removes), fixtures are used to verify that that operation results in correct state for the map and its collection views. Basically, the modification is performed against your map implementation, and an identical modification is performed against a confirmed map implementation. A confirmed map implementation is something like java.util.HashMap, which is known to conform exactly to the Map contract. After the modification takes place on both your map implementation and the confirmed map implementation, the two maps are compared to see if their state is identical. The comparison also compares the collection views to make sure they're still the same.

The upshot of all that is that any test that modifies the map in any way will verify that all of the map's state is still correct, including the state of its collection views. So for instance if a key is removed by the map's key set's iterator, then the entry set is checked to make sure the key/value pair no longer appears.

The AbstractTestMap.map field holds an instance of your collection implementation. The AbstractTestMap.entrySet , AbstractTestMap.keySet and AbstractTestMap.values fields hold that map's collection views. And the AbstractTestMap.confirmed field holds an instance of the confirmed collection implementation. The AbstractTestMap.resetEmpty() and AbstractTestMap.resetFull() methods set these fields to empty or full maps, so that tests can proceed from a known state.

After a modification operation to both AbstractTestMap.map and AbstractTestMap.confirmed , the AbstractTestMap.verify() method is invoked to compare the results. The AbstractTestMap.verify method calls separate methods to verify the map and its three collection views ( AbstractTestMap.verifyMap , AbstractTestMap.verifyEntrySet , AbstractTestMap.verifyKeySet , and AbstractTestMap.verifyValues ). You may want to override one of the verification methodsto perform additional verifications. For instance, TestDoubleOrderedMap would want override its AbstractTestMap.verifyValues() method to verify that the values are unique and in ascending order.

Other Notes

If your Map fails one of these tests by design, you may still use this base set of cases. Simply override the test case (method) your map fails and/or the methods that define the assumptions used by the test cases. For example, if your map does not allow duplicate values, override AbstractTestMap.isAllowDuplicateValues() and have it return false
author:
   Michael Smith
author:
   Rodney Waldhoff
author:
   Paul Jack
author:
   Stephen Colebourne
version:
   $Revision: 169097 $ $Date: 2005-05-07 18:13:40 +0100 (Sat, 07 May 2005) $

Override getOtherElements to returnthe results of this method if your collection does not support heterogenous elements or the null element.

Default implementation returns true. Override if your collection class does not support duplicate values.

Default implementation returns true. Override if your collection class does not support null keys.

Default implementation returns true. Override if your collection class does not support null values.

Default implementation returns false. Override if your map class structurally modifies on get.

Default implementation returns true. Override if your collection class does not support put adding.

Default implementation returns true. Override if your collection class does not support put changing.

Default implementation returns true. Override if your collection class does not support removal operations.

Default implementation returns isPutChangeSupported(). Override if your collection class does not support setValue but does support put changing.

We should really test the "vice versa" case--that values removed from the map are removed from the values collection--also, but that's a more difficult test to construct (lacking a "removeValue" method.)

See bug 9573.