com.diffplug.common.collect.testing

Class DerivedCollectionGenerators.SortedMapSubmapTestMapGenerator<K,V>

java.lang.Object

com.diffplug.common.collect.testing.DerivedCollectionGenerators.SortedMapSubmapTestMapGenerator<K,V>

All Implemented Interfaces:

TestContainerGenerator<Map<K,V>,Map.Entry<K,V>>, TestMapGenerator<K,V>, TestSortedMapGenerator<K,V>

Direct Known Subclasses:

NavigableMapTestSuiteBuilder.NavigableMapSubmapTestMapGenerator

Enclosing class:

DerivedCollectionGenerators

public static class DerivedCollectionGenerators.SortedMapSubmapTestMapGenerator<K,V>
extends Object
implements TestSortedMapGenerator<K,V>

Constructor Summary

Constructors

Constructor and Description
SortedMapSubmapTestMapGenerator(TestSortedMapGenerator<K,V> delegate, DerivedCollectionGenerators.Bound to, DerivedCollectionGenerators.Bound from)

Method Summary

Modifier and Type	Method and Description
Map.Entry<K,V>	aboveSamplesGreater() Returns an entry with a key greater than the keys of the TestContainerGenerator.samples() and greater than the key of TestSortedMapGenerator.aboveSamplesLesser().
Map.Entry<K,V>	aboveSamplesLesser() Returns an entry with a key greater than the keys of the TestContainerGenerator.samples() but less than the key of TestSortedMapGenerator.aboveSamplesGreater().
Map.Entry<K,V>	belowSamplesGreater() Returns an entry with a key less than the keys of the TestContainerGenerator.samples() but greater than the key of TestSortedMapGenerator.belowSamplesLesser().
Map.Entry<K,V>	belowSamplesLesser() Returns an entry with a key less than the keys of the TestContainerGenerator.samples() and less than the key of TestSortedMapGenerator.belowSamplesGreater().
SortedMap<K,V>	create(Object... entries) Creates a new container containing the given elements.
Map.Entry<K,V>[]	createArray(int length) Helper method to create an array of the appropriate type used by this generator.
K[]	createKeyArray(int length)
V[]	createValueArray(int length)
DerivedCollectionGenerators.Bound	getFrom()
TestSortedMapGenerator<K,V>	getInnerGenerator()
DerivedCollectionGenerators.Bound	getTo()
Iterable<Map.Entry<K,V>>	order(List<Map.Entry<K,V>> insertionOrder) Returns the iteration ordering of elements, given the order in which they were added to the container.
SampleElements<Map.Entry<K,V>>	samples() Returns the sample elements that this generate populates its container with.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.diffplug.common.collect.testing.TestMapGenerator

createKeyArray, createValueArray

Methods inherited from interface com.diffplug.common.collect.testing.TestContainerGenerator

createArray, order, samples

Constructor Detail

SortedMapSubmapTestMapGenerator

public SortedMapSubmapTestMapGenerator(TestSortedMapGenerator<K,V> delegate,
                                       DerivedCollectionGenerators.Bound to,
                                       DerivedCollectionGenerators.Bound from)

Method Detail

create

public SortedMap<K,V> create(Object... entries)

Description copied from interface: TestContainerGenerator

Creates a new container containing the given elements. TODO: would be nice to figure out how to use E… or E[] as a parameter type, but this doesn’t seem to work because Java creates an array of the erased type.

Specified by:

create in interface TestContainerGenerator<Map<K,V>,Map.Entry<K,V>>

Specified by:

create in interface TestSortedMapGenerator<K,V>

getTo

public final DerivedCollectionGenerators.Bound getTo()

getFrom

public final DerivedCollectionGenerators.Bound getFrom()

getInnerGenerator

public final TestSortedMapGenerator<K,V> getInnerGenerator()

belowSamplesLesser

public Map.Entry<K,V> belowSamplesLesser()

Description copied from interface: TestSortedMapGenerator

Returns an entry with a key less than the keys of the TestContainerGenerator.samples() and less than the key of TestSortedMapGenerator.belowSamplesGreater().

Specified by:

belowSamplesLesser in interface TestSortedMapGenerator<K,V>

belowSamplesGreater

public Map.Entry<K,V> belowSamplesGreater()

Description copied from interface: TestSortedMapGenerator

Returns an entry with a key less than the keys of the TestContainerGenerator.samples() but greater than the key of TestSortedMapGenerator.belowSamplesLesser().

Specified by:

belowSamplesGreater in interface TestSortedMapGenerator<K,V>

aboveSamplesLesser

public Map.Entry<K,V> aboveSamplesLesser()

Description copied from interface: TestSortedMapGenerator

Returns an entry with a key greater than the keys of the TestContainerGenerator.samples() but less than the key of TestSortedMapGenerator.aboveSamplesGreater().

Specified by:

aboveSamplesLesser in interface TestSortedMapGenerator<K,V>

aboveSamplesGreater

public Map.Entry<K,V> aboveSamplesGreater()

Description copied from interface: TestSortedMapGenerator

Returns an entry with a key greater than the keys of the TestContainerGenerator.samples() and greater than the key of TestSortedMapGenerator.aboveSamplesLesser().

Specified by:

aboveSamplesGreater in interface TestSortedMapGenerator<K,V>

order

public Iterable<Map.Entry<K,V>> order(List<Map.Entry<K,V>> insertionOrder)

Description copied from interface: TestContainerGenerator

Returns the iteration ordering of elements, given the order in which they were added to the container. This method may return the original list unchanged, the original list modified in place, or a different list.

This method runs only when CollectionFeature.KNOWN_ORDER is specified when creating the test suite. It should never run when testing containers such as HashSet, which have a non-deterministic iteration order.

Specified by:

order in interface TestContainerGenerator<Map<K,V>,Map.Entry<K,V>>

createKeyArray

public K[] createKeyArray(int length)

Specified by:

createKeyArray in interface TestMapGenerator<K,V>

createValueArray

public V[] createValueArray(int length)

Specified by:

createValueArray in interface TestMapGenerator<K,V>

samples

public SampleElements<Map.Entry<K,V>> samples()

Description copied from interface: TestContainerGenerator

Returns the sample elements that this generate populates its container with.

Specified by:

samples in interface TestContainerGenerator<Map<K,V>,Map.Entry<K,V>>

createArray

public Map.Entry<K,V>[] createArray(int length)

Description copied from interface: TestContainerGenerator

Helper method to create an array of the appropriate type used by this generator. The returned array will contain only nulls.

Specified by:

createArray in interface TestContainerGenerator<Map<K,V>,Map.Entry<K,V>>