org.apache.commons.collections.set
Class AbstractTestSet

java.lang.Object
  extended byjunit.framework.Assert
      extended byjunit.framework.TestCase
          extended byorg.apache.commons.collections.BulkTest
              extended byorg.apache.commons.collections.AbstractTestObject
                  extended byorg.apache.commons.collections.collection.AbstractTestCollection
                      extended byorg.apache.commons.collections.set.AbstractTestSet
All Implemented Interfaces:
java.lang.Cloneable, junit.framework.Test
Direct Known Subclasses:
AbstractTestMap.TestMapEntrySet, AbstractTestMap.TestMapKeySet, AbstractTestSortedSet

public abstract class AbstractTestSet
extends AbstractTestCollection

Abstract test class for Set methods and contracts.

Since Set doesn't stipulate much new behavior that isn't already found in Collection, this class basically just adds tests for Set.equals(java.lang.Object) and Set.hashCode() along with an updated verify() that ensures elements do not appear more than once in the set.

To use, subclass and override the makeEmptySet() method. You may have to override other protected methods if your set is not modifiable, or if your set restricts what kinds of elements may be added; see AbstractTestCollection for more details.

Since:
Commons Collections 3.0

Field Summary
 
Fields inherited from class org.apache.commons.collections.collection.AbstractTestCollection
collection, confirmed
 
Fields inherited from class org.apache.commons.collections.AbstractTestObject
COLLECTIONS_MAJOR_VERSION
 
Constructor Summary
AbstractTestSet(java.lang.String name)
          JUnit constructor.
 
Method Summary
 java.util.Set getConfirmedSet()
          Return the AbstractTestCollection.confirmed fixture, but cast as a Set.
 java.util.Set getSet()
          Return the AbstractTestCollection.collection fixture, but cast as a Set.
 boolean isEqualsCheckable()
          Set equals method is defined.
 java.util.Collection makeCollection()
          Makes an empty collection by invoking makeEmptySet().
 java.util.Collection makeConfirmedCollection()
          Returns an empty Set for use in modification testing.
 java.util.Collection makeConfirmedFullCollection()
          Returns a full Set for use in modification testing.
abstract  java.util.Set makeEmptySet()
          Makes an empty set.
 java.util.Collection makeFullCollection()
          Makes a full collection by invoking makeFullSet().
 java.util.Set makeFullSet()
          Makes a full set by first creating an empty set and then adding all the elements returned by AbstractTestCollection.getFullElements().
 void testSetEquals()
          Tests Set.equals(Object).
 void testSetHashCode()
          Tests Set.hashCode().
 void verify()
          Provides additional verifications for sets.
 
Methods inherited from class org.apache.commons.collections.collection.AbstractTestCollection
areEqualElementsDistinguishable, cloneMapEntry, getFullElements, getFullNonNullElements, getFullNonNullStringElements, getOtherElements, getOtherNonNullElements, getOtherNonNullStringElements, isAddSupported, isFailFastSupported, isNullSupported, isRemoveSupported, makeObject, resetEmpty, resetFull, testCollectionAdd, testCollectionAddAll, testCollectionClear, testCollectionContains, testCollectionContainsAll, testCollectionIsEmpty, testCollectionIterator, testCollectionIteratorFailFast, testCollectionIteratorRemove, testCollectionRemove, testCollectionRemoveAll, testCollectionRetainAll, testCollectionSize, testCollectionToArray, testCollectionToArray2, testCollectionToString, testSerializeDeserializeThenCompare, testUnsupportedAdd, testUnsupportedRemove
 
Methods inherited from class org.apache.commons.collections.AbstractTestObject
getCanonicalEmptyCollectionName, getCanonicalFullCollectionName, getCompatibilityVersion, isTestSerialization, readExternalFormFromBytes, readExternalFormFromDisk, skipSerializedCanonicalTests, supportsEmptyCollections, supportsFullCollections, testCanonicalEmptyCollectionExists, testCanonicalFullCollectionExists, testEqualsNull, testObjectEqualsSelf, testObjectHashCodeEqualsContract, testObjectHashCodeEqualsSelfHashCode, testSimpleSerialization, writeExternalFormToBytes, writeExternalFormToDisk
 
Methods inherited from class org.apache.commons.collections.BulkTest
clone, ignoredTests, makeSuite, toString
 
Methods inherited from class junit.framework.TestCase
countTestCases, createResult, getName, run, run, runBare, runTest, setName, setUp, tearDown
 
Methods inherited from class junit.framework.Assert
assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, fail, fail, failNotEquals, failNotSame, failSame
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractTestSet

public AbstractTestSet(java.lang.String name)
JUnit constructor.

Parameters:
name - name for test
Method Detail

verify

public void verify()
Provides additional verifications for sets.

Overrides:
verify in class AbstractTestCollection

isEqualsCheckable

public boolean isEqualsCheckable()
Set equals method is defined.

Overrides:
isEqualsCheckable in class AbstractTestCollection

makeConfirmedCollection

public java.util.Collection makeConfirmedCollection()
Returns an empty Set for use in modification testing.

Specified by:
makeConfirmedCollection in class AbstractTestCollection
Returns:
a confirmed empty collection

makeConfirmedFullCollection

public java.util.Collection makeConfirmedFullCollection()
Returns a full Set for use in modification testing.

Specified by:
makeConfirmedFullCollection in class AbstractTestCollection
Returns:
a confirmed full collection

makeEmptySet

public abstract java.util.Set makeEmptySet()
Makes an empty set. The returned set should have no elements.

Returns:
an empty set

makeFullSet

public java.util.Set makeFullSet()
Makes a full set by first creating an empty set and then adding all the elements returned by AbstractTestCollection.getFullElements(). Override if your set does not support the add operation.

Returns:
a full set

makeCollection

public final java.util.Collection makeCollection()
Makes an empty collection by invoking makeEmptySet().

Specified by:
makeCollection in class AbstractTestCollection
Returns:
an empty collection

makeFullCollection

public final java.util.Collection makeFullCollection()
Makes a full collection by invoking makeFullSet().

Overrides:
makeFullCollection in class AbstractTestCollection
Returns:
a full collection

getSet

public java.util.Set getSet()
Return the AbstractTestCollection.collection fixture, but cast as a Set.


getConfirmedSet

public java.util.Set getConfirmedSet()
Return the AbstractTestCollection.confirmed fixture, but cast as a Set.


testSetEquals

public void testSetEquals()
Tests Set.equals(Object).


testSetHashCode

public void testSetHashCode()
Tests Set.hashCode().



Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.