org.apache.commons.collections.map
public abstract class AbstractTestMap extends AbstractTestObject
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 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:
Supported Operation MethodsOverride these methods if your map doesn't support certain operations:
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 map field holds an instance of your collection implementation. The entrySet, keySet and values fields hold that map's collection views. And the confirmed field holds an instance of the confirmed collection implementation. The resetEmpty and 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 map and confirmed, the verify method is invoked to compare the results. The AbstractTestMap method calls separate methods to verify the map and its three collection views (AbstractTestMap, AbstractTestMap, AbstractTestMap, and AbstractTestMap). You may want to override one of the verification methodsto perform additional verifications. For instance, TestDoubleOrderedMap would want override its 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
isAllowDuplicateValues and have it return false
Nested Class Summary | |
---|---|
class | AbstractTestMap.TestMapEntrySet |
class | AbstractTestMap.TestMapKeySet |
class | AbstractTestMap.TestMapValues |
Field Summary | |
---|---|
protected Map | confirmed HashMap created by reset(). |
protected Set | entrySet Entry set of map created by reset(). |
protected Set | keySet Key set of map created by reset(). |
protected Map | map Map created by reset(). |
protected Collection | values Values collection of map created by reset(). |
Constructor Summary | |
---|---|
AbstractTestMap(String testName)
JUnit constructor.
|
Method Summary | |
---|---|
void | addSampleMappings(Map m)
Helper method to add all the mappings described by
getSampleKeys and getSampleValues. |
BulkTest | bulkTestMapEntrySet()
Bulk test Map#entrySet(). |
BulkTest | bulkTestMapKeySet()
Bulk test Map#keySet(). |
BulkTest | bulkTestMapValues()
Bulk test Map#values(). |
Entry | cloneMapEntry(Entry entry)
Creates a new Map Entry that is independent of the first and the map. |
String | getCompatibilityVersion()
Gets the compatability version, needed for package access. |
Object[] | getNewSampleValues()
Returns a the set of values that can be used to replace the values
returned from getSampleValues. |
Object[] | getOtherKeys() |
Object[] | getOtherNonNullStringElements()
Returns a list of string elements suitable for return by
getOtherKeys or AbstractTestMap.
|
Object[] | getOtherValues() |
Object[] | getSampleKeys()
Returns the set of keys in the mappings used to test the map. |
Object[] | getSampleValues()
Returns the set of values in the mappings used to test the map. |
boolean | isAllowDuplicateValues()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
supports duplicate values.
|
boolean | isAllowNullKey()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
supports null keys.
|
boolean | isAllowNullValue()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
supports null values.
|
boolean | isGetStructuralModify()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
can cause structural modification on a get(). |
boolean | isPutAddSupported()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
support the put and putAll operations
adding new mappings.
|
boolean | isPutChangeSupported()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
support the put and putAll operations
changing existing mappings.
|
boolean | isRemoveSupported()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
support the remove and clear operations.
|
boolean | isSetValueSupported()
Returns true if the maps produced by
makeEmptyMap and makeFullMap
support the setValue operation on entrySet entries.
|
boolean | isSubMapViewsSerializable()
Returns whether the sub map views of SortedMap are serializable.
|
Map | makeConfirmedMap()
Override to return a map other than HashMap as the confirmed map.
|
abstract Map | makeEmptyMap()
Return a new, empty Map to be used for testing.
|
Map | makeFullMap()
Return a new, populated map. |
Object | makeObject()
Implements the superclass method to return the map to be tested.
|
void | resetEmpty() |
void | resetFull() |
void | tearDown()
Erases any leftover instance variables by setting them to null. |
void | testEmptyMapCompatibility()
Compare the current serialized form of the Map
against the canonical version in CVS. |
void | testEntrySetClearChangesMap()
Tests that the Map#entrySet() collection is backed by
the underlying map for clear(). |
void | testEntrySetContains1() |
void | testEntrySetContains2() |
void | testEntrySetContains3() |
void | testEntrySetRemove1() |
void | testEntrySetRemove2() |
void | testEntrySetRemove3() |
void | testFullMapCompatibility()
Compare the current serialized form of the Map
against the canonical version in CVS. |
void | testKeySetClearChangesMap()
Tests that the Map#keySet collection is backed by
the underlying map for clear(). |
void | testKeySetRemoveChangesMap()
Tests that the Map#keySet set is backed by
the underlying map by removing from the keySet set
and testing if the key was removed from the map. |
void | testMakeMap()
Test to ensure that makeEmptyMap and makeFull returns a new non-null
map with each invocation. |
void | testMapClear()
Tests Map#clear(). |
void | testMapContainsKey()
Tests Map.containsKey(Object) by verifying it returns false for all
sample keys on a map created using an empty map and returns true for
all sample keys returned on a full map. |
void | testMapContainsValue()
Tests Map.containsValue(Object) by verifying it returns false for all
sample values on an empty map and returns true for all sample values on
a full map. |
void | testMapEquals()
Tests Map.equals(Object) |
void | testMapGet()
Tests Map.get(Object) |
void | testMapHashCode()
Tests Map.hashCode() |
void | testMapIsEmpty()
Tests Map.isEmpty() |
void | testMapPut()
Tests Map.put(Object, Object) |
void | testMapPutAll()
Tests Map.putAll(map) |
void | testMapPutNullKey()
Tests Map.put(null, value) |
void | testMapPutNullValue()
Tests Map.put(null, value) |
void | testMapRemove()
Tests Map.remove(Object) |
void | testMapSize()
Tests Map.size() |
void | testMapToString()
Tests Map.toString(). |
void | testSampleMappings()
Test to ensure the test setup is working properly. |
void | testValuesClearChangesMap()
Tests that the Map#values collection is backed by
the underlying map for clear(). |
void | testValuesRemoveChangesMap()
Tests that the Map#values collection is backed by
the underlying map by removing from the values collection
and testing if the value was removed from the map.
|
void | verify() |
void | verifyEntrySet() |
void | verifyKeySet() |
void | verifyMap() |
void | verifyValues() |
Parameters: testName the test name
Returns: a AbstractTestSet instance for testing the map's entry set
Returns: a AbstractTestSet instance for testing the map's key set
Returns: a AbstractTestCollection instance for testing the map's values collection
true
, and includes two values
that are the same if isAllowDuplicateValues returns
true
.Override getOtherElements to returnthe results of this method if your collection does not support heterogenous elements or the null element.
true
.true
, and includes
two values that are the same if isAllowDuplicateValues returns
true
.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.
put
and putAll
operations
adding new mappings.
Default implementation returns true. Override if your collection class does not support put adding.
put
and putAll
operations
changing existing mappings.
Default implementation returns true. Override if your collection class does not support put changing.
remove
and clear
operations.
Default implementation returns true. Override if your collection class does not support removal operations.
setValue
operation on entrySet entries.
Default implementation returns isPutChangeSupported(). Override if your collection class does not support setValue but does support put changing.
Returns: false
Returns: a map that is known to be valid
Returns: the map to be tested
Returns: the map to be tested
Returns: the map to be tested
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.
equals
test
is done on the maps and their collection views; their size and
isEmpty
results are compared; their hashCodes are
compared; and containsAll
tests are run on the
collection views.