Class AbstractMapTester<K extends @Nullable Object, V extends @Nullable Object>

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

com.google.common.collect.testing.AbstractTester<OneSizeTestContainerGenerator<Map<K,V>, Map.Entry<K,V>>>

com.google.common.collect.testing.AbstractContainerTester<Map<K,V>, Map.Entry<K,V>>

com.google.common.collect.testing.AbstractMapTester<K,V>

Type Parameters:

K - the key type of the map to be tested.

V - the value type of the map to be tested.

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

AbstractBiMapTester, ConcurrentMapPutIfAbsentTester, ConcurrentMapRemoveTester, ConcurrentMapReplaceEntryTester, ConcurrentMapReplaceTester, MapClearTester, MapComputeIfAbsentTester, MapComputeIfPresentTester, MapComputeTester, MapContainsKeyTester, MapContainsValueTester, MapCreationTester, MapEntrySetTester, MapEqualsTester, MapForEachTester, MapGetOrDefaultTester, MapGetTester, MapHashCodeTester, MapIsEmptyTester, MapMergeTester, MapPutAllTester, MapPutIfAbsentTester, MapPutTester, MapRemoveEntryTester, MapRemoveTester, MapReplaceAllTester, MapReplaceEntryTester, MapReplaceTester, MapSerializationTester, MapSizeTester, MapToStringTester, NavigableMapNavigationTester, SortedMapNavigationTester

@GwtCompatible
@NullMarked
public abstract class AbstractMapTester<K extends @Nullable Object, V extends @Nullable Object>
extends AbstractContainerTester<Map<K,V>, Map.Entry<K,V>>

Base class for map testers.

TODO: see how much of this is actually needed once Map testers are written. (It was cloned from AbstractCollectionTester.)

Author:

George van den Driessche

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 inherited from class AbstractContainerTester

container, samples

Modifier and Type	Field	Description
protected Map<K,V>	container
protected SampleElements<Map.Entry<K,V>>	samples

Constructor Summary

Constructors

Constructor	Description
AbstractMapTester()

Method Summary

Modifier and Type	Method	Description
protected Collection<Map.Entry<K,V>>	actualContents()
protected Map.Entry<K,V>[]	createArrayWithNullKey()
protected Map.Entry<K,V>[]	createArrayWithNullValue()
protected MinimalCollection<Map.Entry<K,V>>	createDisjointCollection()
protected Map.Entry<K,V>	entry(K key, V value)
protected void	expectContents(Collection<Map.Entry<K,V>> expected)	Asserts that the collection under test contains exactly the given elements, respecting cardinality but not order.
protected void	expectMissing(Map.Entry<K,V>... entries)
protected void	expectMissingKeys(K... elements)
protected void	expectMissingValues(V... elements)
protected void	expectNullKeyMissingWhenNullKeysUnsupported(String message)	Equivalent to expectMissingKeys (null) except that the call to contains(null) is permitted to throw a NullPointerException.
protected void	expectNullValueMissingWhenNullValuesUnsupported(String message)	Equivalent to expectMissingValues (null) except that the call to contains(null) is permitted to throw a NullPointerException.
protected final void	expectReplacement(Map.Entry<K,V> newEntry)
protected V	get(K key)	Wrapper for Map.get(Object) that forces the caller to pass in a key of the same type as the map.
protected K	getKeyForNullValue()
protected Map<K,V>	getMap()
protected int	getNumEntries()
protected Collection<Map.Entry<K,V>>	getSampleEntries()
protected Collection<Map.Entry<K,V>>	getSampleEntries(int howMany)
protected V	getValueForNullKey()
protected void	initMapWithNullKey()
protected void	initMapWithNullValue()
protected final K	k0()
protected final K	k1()
protected final K	k2()
protected final K	k3()
protected final K	k4()
protected final void	resetMap()
protected void	resetMap(Map.Entry<K,V>[] entries)
protected final V	v0()
protected final V	v1()
protected final V	v2()
protected final V	v3()
protected final V	v4()

Methods inherited from class AbstractContainerTester

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

Modifier and Type	Method	Description
protected AbstractContainerTester.ArrayWithDuplicate<Map.Entry<K,V>>	createArrayWithDuplicateElement()
protected Map.Entry<K,V>[]	createOrderedArray()
protected Map.Entry<K,V>[]	createSamplesArray()
protected final Map.Entry<K,V>	e0()
protected final Map.Entry<K,V>	e1()
protected final Map.Entry<K,V>	e2()
protected final Map.Entry<K,V>	e3()
protected final Map.Entry<K,V>	e4()
protected MinimalCollection<Map.Entry<K,V>>	emptyCollection()
protected final void	expectAdded(int index, Map.Entry<K,V>... elements)
protected final void	expectAdded(int index, Collection<Map.Entry<K,V>> elements)
protected final void	expectAdded(Map.Entry<K,V>... 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(Map.Entry<K,V>... elements)
protected void	expectUnchanged()
protected int	getNullLocation()
protected int	getNumElements()
protected List<Map.Entry<K,V>>	getOrderedElements()	Returns the sample elements as ordered by TestContainerGenerator.order(List).
protected Collection<Map.Entry<K,V>>	getSampleElements()
protected Collection<Map.Entry<K,V>>	getSampleElements(int howMany)
protected Map<K,V>	resetContainer()	Replaces the existing container under test with a new container created by the subject generator.
protected Map<K,V>	resetContainer(Map<K,V> newValue)	Replaces the existing container under test with a new container.
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<Map<K,V>, Map.Entry<K,V>>	getSubjectGenerator()
final String	getTestMethodName()	Returns the name of the test method invoked by this test instance.
final void	init(OneSizeTestContainerGenerator<Map<K,V>, Map.Entry<K,V>> subjectGenerator, String suiteName)
final void	init(OneSizeTestContainerGenerator<Map<K,V>, Map.Entry<K,V>> 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

Constructor Details

AbstractMapTester

public AbstractMapTester()

Method Details

getMap

protected Map<K,V> getMap()

actualContents

protected Collection<Map.Entry<K,V>> actualContents()

Specified by:

actualContents in class AbstractContainerTester<Map<K extends @Nullable Object, V extends @Nullable Object>, Map.Entry<K extends @Nullable Object, V extends @Nullable Object>>

Returns:

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

resetMap

protected final void resetMap()

See Also:

• AbstractContainerTester.resetContainer()

resetMap

protected void resetMap(Map.Entry<K,V>[] entries)

expectMissingKeys

protected void expectMissingKeys(K... elements)

expectMissingValues

protected void expectMissingValues(V... elements)

createArrayWithNullKey

protected Map.Entry<K,V>[] createArrayWithNullKey()

Returns:

an array of the proper size with null as the key of the middle element.

getValueForNullKey

protected V getValueForNullKey()

getKeyForNullValue

protected K getKeyForNullValue()

createArrayWithNullValue

protected Map.Entry<K,V>[] createArrayWithNullValue()

Returns:

an array of the proper size with null as the value of the middle element.

initMapWithNullKey

protected void initMapWithNullKey()

initMapWithNullValue

protected void initMapWithNullValue()

expectNullKeyMissingWhenNullKeysUnsupported

protected void expectNullKeyMissingWhenNullKeysUnsupported(String message)

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

Parameters:

message - message to use upon assertion failure

expectNullValueMissingWhenNullValuesUnsupported

protected void expectNullValueMissingWhenNullValuesUnsupported(String message)

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

Parameters:

message - message to use upon assertion failure

createDisjointCollection

protected MinimalCollection<Map.Entry<K,V>> createDisjointCollection()

Overrides:

createDisjointCollection in class AbstractContainerTester<Map<K extends @Nullable Object, V extends @Nullable Object>, Map.Entry<K extends @Nullable Object, V extends @Nullable Object>>

getNumEntries

protected int getNumEntries()

getSampleEntries

protected Collection<Map.Entry<K,V>> getSampleEntries(int howMany)

getSampleEntries

protected Collection<Map.Entry<K,V>> getSampleEntries()

expectMissing

protected void expectMissing(Map.Entry<K,V>... entries)

Overrides:

expectMissing in class AbstractContainerTester<Map<K extends @Nullable Object, V extends @Nullable Object>, Map.Entry<K extends @Nullable Object, V extends @Nullable Object>>

entry

protected Map.Entry<K,V> entry(K key,
 V value)

expectContents

protected void expectContents(Collection<Map.Entry<K,V>> expected)

Description copied from class: AbstractContainerTester

Asserts that the collection under test contains exactly the given elements, respecting cardinality but not order. Subclasses may override this method to provide stronger assertions, e.g., to check ordering in lists, but realize that unless a test extends AbstractListTester, a call to expectContents() invokes this version.

Overrides:

expectContents in class AbstractContainerTester<Map<K extends @Nullable Object, V extends @Nullable Object>, Map.Entry<K extends @Nullable Object, V extends @Nullable Object>>

Parameters:

expected - expected value of AbstractContainerTester.container

expectReplacement

protected final void expectReplacement(Map.Entry<K,V> newEntry)

get

protected V get(K key)

Wrapper for Map.get(Object) that forces the caller to pass in a key of the same type as the map. Besides being slightly shorter than code that uses getMap(), it also ensures that callers don't pass an Map.Entry by mistake.

k0

protected final K k0()

v0

protected final V v0()

k1

protected final K k1()

v1

protected final V v1()

k2

protected final K k2()

v2

protected final V v2()

k3

protected final K k3()

v3

protected final V v3()

k4

protected final K k4()

v4

protected final V v4()