Class AbstractCollectionTester<E extends @Nullable Object>

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

com.google.common.collect.testing.AbstractTester<OneSizeTestContainerGenerator<Collection<E>, E>>

com.google.common.collect.testing.AbstractContainerTester<Collection<E>, E>

com.google.common.collect.testing.AbstractCollectionTester<E>

Type Parameters:

E - the element type of the collection to be tested.

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

AbstractListTester, AbstractMultisetTester, AbstractQueueTester, AbstractSetTester, CollectionAddAllTester, CollectionAddTester, CollectionClearTester, CollectionContainsAllTester, CollectionContainsTester, CollectionCreationTester, CollectionEqualsTester, CollectionForEachTester, CollectionIsEmptyTester, CollectionIteratorTester, CollectionRemoveAllTester, CollectionRemoveIfTester, CollectionRemoveTester, CollectionRetainAllTester, CollectionSerializationEqualTester, CollectionSerializationTester, CollectionSizeTester, CollectionSpliteratorTester, CollectionStreamTester, CollectionToArrayTester, CollectionToStringTester

@GwtCompatible
@NullMarked
public abstract class AbstractCollectionTester<E extends @Nullable Object>
extends AbstractContainerTester<Collection<E>, E>

Base class for collection testers.

Author:

Kevin Bourrillion

Nested Class Summary

Nested classes/interfaces inherited from class AbstractContainerTester

AbstractContainerTester.ArrayWithDuplicate<E>

Modifier and Type	Class	Description
static final class	AbstractContainerTester.ArrayWithDuplicate<E extends @Nullable Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<E>	collection

Fields inherited from class AbstractContainerTester

container, samples

Modifier and Type	Field	Description
protected Collection<E>	container
protected SampleElements<E>	samples

Constructor Summary

Constructors

Constructor	Description
AbstractCollectionTester()

Method Summary

Modifier and Type	Method	Description
protected Collection<E>	actualContents()
protected E[]	createArrayWithNullElement()
protected void	expectNullMissingWhenNullUnsupported(String message)	Equivalent to expectMissing(null) except that the call to contains(null) is permitted to throw a NullPointerException.
protected void	initCollectionWithNullElement()
protected void	resetCollection()
protected Collection<E>	resetContainer(Collection<E> newContents)	Replaces the existing container under test with a new container.

Methods inherited from class AbstractContainerTester

createArrayWithDuplicateElement, createDisjointCollection, createOrderedArray, createSamplesArray, e0, e1, e2, e3, e4, emptyCollection, expectAdded, expectAdded, expectAdded, expectContents, expectContents, expectMissing, expectUnchanged, getNullLocation, getNumElements, getOrderedElements, getSampleElements, getSampleElements, resetContainer, setUp

Modifier and Type	Method	Description
protected AbstractContainerTester.ArrayWithDuplicate<E>	createArrayWithDuplicateElement()
protected MinimalCollection<E>	createDisjointCollection()
protected E[]	createOrderedArray()
protected E[]	createSamplesArray()
protected final E	e0()
protected final E	e1()
protected final E	e2()
protected final E	e3()
protected final E	e4()
protected MinimalCollection<E>	emptyCollection()
protected final void	expectAdded(int index, E... elements)
protected final void	expectAdded(int index, Collection<E> elements)
protected final void	expectAdded(E... elements)	Asserts that the collection under test contains exactly the elements it was initialized with plus the given elements, according to AbstractContainerTester.expectContents(java.util.Collection).
protected final void	expectContents(E... elements)
protected void	expectContents(Collection<E> expected)	Asserts that the collection under test contains exactly the given elements, respecting cardinality but not order.
protected void	expectMissing(E... elements)
protected void	expectUnchanged()
protected int	getNullLocation()
protected int	getNumElements()
protected List<E>	getOrderedElements()	Returns the sample elements as ordered by TestContainerGenerator.order(List).
protected Collection<E>	getSampleElements()
protected Collection<E>	getSampleElements(int howMany)
protected Collection<E>	resetContainer()	Replaces the existing container under test with a new container created by the subject generator.
void	setUp()

Methods inherited from class AbstractTester

assertNull, getName, getSubjectGenerator, getTestMethodName, init, init, tearDown

Modifier and Type	Method	Description
static void	assertNull(String message, @Nullable Object object)	Asserts that the given object is non-null, with a better failure message than TestCase.assertNull(String, Object).
String	getName()
OneSizeTestContainerGenerator<Collection<E>, E>	getSubjectGenerator()
final String	getTestMethodName()	Returns the name of the test method invoked by this test instance.
final void	init(OneSizeTestContainerGenerator<Collection<E>, E> subjectGenerator, String suiteName)
final void	init(OneSizeTestContainerGenerator<Collection<E>, E> subjectGenerator, String suiteName, @Nullable Runnable setUp, @Nullable Runnable tearDown)
void	tearDown()

Methods inherited from class junit.framework.TestCase

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, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, run, run, runBare, runTest, setName, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

collection

protected Collection<E extends @Nullable Object> collection

Constructor Details

AbstractCollectionTester

public AbstractCollectionTester()

Method Details

actualContents

protected Collection<E> actualContents()

Specified by:

actualContents in class AbstractContainerTester<Collection<E extends @Nullable Object>, E extends @Nullable Object>

Returns:

the contents of the container under test, for use by expectContents(E...) and its friends.

resetContainer

@CanIgnoreReturnValue
protected Collection<E> resetContainer(Collection<E> newContents)

Description copied from class: AbstractContainerTester

Replaces the existing container under test with a new container. This is useful when a single test method needs to create multiple containers while retaining the ability to use expectContents(E...) and other convenience methods. The creation of multiple containers in a single method is discouraged in most cases, but it is vital to the iterator tests.

Overrides:

resetContainer in class AbstractContainerTester<Collection<E extends @Nullable Object>, E extends @Nullable Object>

Parameters:

newContents - the new container instance

Returns:

the new container instance

resetCollection

protected void resetCollection()

See Also:

• AbstractContainerTester.resetContainer()

createArrayWithNullElement

protected E[] createArrayWithNullElement()

Returns:

an array of the proper size with null inserted into the middle element.

initCollectionWithNullElement

protected void initCollectionWithNullElement()

expectNullMissingWhenNullUnsupported

protected void expectNullMissingWhenNullUnsupported(String message)

Equivalent to expectMissing(null) except that the call to contains(null) is permitted to throw a NullPointerException.

Parameters:

message - message to use upon assertion failure