com.google.common.collect.testing

Interface TestContainerGenerator<T,E>

All Known Subinterfaces:

OneSizeTestContainerGenerator<T,E>, TestBiMapGenerator<K,V>, TestCollectionGenerator<E>, TestListGenerator<E>, TestListMultimapGenerator<K,V>, TestMapGenerator<K,V>, TestMultimapGenerator<K,V,M>, TestMultisetGenerator<E>, TestQueueGenerator<E>, TestSetGenerator<E>, TestSetMultimapGenerator<K,V>, TestSortedMapGenerator<K,V>

All Known Implementing Classes:

BiMapGenerators.ImmutableBiMapGenerator, DerivedCollectionGenerators.MapEntrySetGenerator, DerivedCollectionGenerators.MapKeySetGenerator, DerivedCollectionGenerators.MapValueCollectionGenerator, DerivedCollectionGenerators.SortedMapSubmapTestMapGenerator, DerivedGoogleCollectionGenerators.BiMapValueSetGenerator, DerivedGoogleCollectionGenerators.InverseBiMapGenerator, DerivedGoogleCollectionGenerators.MapGenerator, ListGenerators.BuilderAddAllListGenerator, ListGenerators.BuilderAddListGenerator, ListGenerators.BuilderReversedListGenerator, ListGenerators.CharactersOfCharSequenceGenerator, ListGenerators.CharactersOfStringGenerator, ListGenerators.ImmutableListHeadSubListGenerator, ListGenerators.ImmutableListMiddleSubListGenerator, ListGenerators.ImmutableListOfGenerator, ListGenerators.ImmutableListTailSubListGenerator, ListGenerators.UnhashableElementsImmutableListGenerator, MapGenerators.ImmutableEnumMapGenerator, MapGenerators.ImmutableMapCopyOfEnumMapGenerator, MapGenerators.ImmutableMapEntryListGenerator, MapGenerators.ImmutableMapGenerator, MapGenerators.ImmutableMapKeyListGenerator, MapGenerators.ImmutableMapUnhashableValuesGenerator, MapGenerators.ImmutableMapValueListGenerator, NavigableMapTestSuiteBuilder.NavigableMapSubmapTestMapGenerator, OneSizeGenerator, ReserializingTestCollectionGenerator, ReserializingTestSetGenerator, SetGenerators.ContiguousSetDescendingGenerator, SetGenerators.ContiguousSetGenerator, SetGenerators.ContiguousSetHeadsetGenerator, SetGenerators.ContiguousSetSubsetGenerator, SetGenerators.ContiguousSetTailsetGenerator, SetGenerators.DegeneratedImmutableSetGenerator, SetGenerators.ImmutableSetAsListGenerator, SetGenerators.ImmutableSetCopyOfGenerator, SetGenerators.ImmutableSetWithBadHashesGenerator, SetGenerators.ImmutableSortedSetAsListGenerator, SetGenerators.ImmutableSortedSetAsListSubListGenerator, SetGenerators.ImmutableSortedSetCopyOfGenerator, SetGenerators.ImmutableSortedSetDescendingAsListGenerator, SetGenerators.ImmutableSortedSetDescendingGenerator, SetGenerators.ImmutableSortedSetExplicitComparator, SetGenerators.ImmutableSortedSetExplicitSuperclassComparatorGenerator, SetGenerators.ImmutableSortedSetHeadsetGenerator, SetGenerators.ImmutableSortedSetReversedOrderGenerator, SetGenerators.ImmutableSortedSetSubsetAsListGenerator, SetGenerators.ImmutableSortedSetSubsetAsListSubListGenerator, SetGenerators.ImmutableSortedSetSubsetGenerator, SetGenerators.ImmutableSortedSetTailsetGenerator, SetGenerators.ImmutableSortedSetUnhashableGenerator, SetGenerators.TestUnhashableSetGenerator, SortedMapGenerators.ImmutableSortedMapEntryListGenerator, SortedMapGenerators.ImmutableSortedMapGenerator, SortedMapGenerators.ImmutableSortedMapKeyListGenerator, SortedMapGenerators.ImmutableSortedMapValueListGenerator, TestCharacterListGenerator, TestCollidingSetGenerator, TestEnumMapGenerator, TestEnumMultisetGenerator, TestEnumSetGenerator, TestIntegerSetGenerator, TestIntegerSortedSetGenerator, TestMapEntrySetGenerator, TestStringBiMapGenerator, TestStringCollectionGenerator, TestStringListGenerator, TestStringListMultimapGenerator, TestStringMapGenerator, TestStringMultisetGenerator, TestStringQueueGenerator, TestStringSetGenerator, TestStringSetMultimapGenerator, TestStringSortedMapGenerator, TestStringSortedSetGenerator, TestUnhashableCollectionGenerator

@GwtCompatible
public interface TestContainerGenerator<T,E>

To be implemented by test generators of things that can contain elements. Such things include both Collection and Map; since there isn't an established collective noun that encompasses both of these, 'container' is used.

This class is GWT compatible.

Author:

George van den Driessche

Method Summary

Methods

Modifier and Type	Method and Description
T	create(Object... elements) Creates a new container containing the given elements.
E[]	createArray(int length) Helper method to create an array of the appropriate type used by this generator.
Iterable<E>	order(List<E> insertionOrder) Returns the iteration ordering of elements, given the order in which they were added to the container.
SampleElements<E>	samples() Returns the sample elements that this generate populates its container with.

Method Detail

samples

SampleElements<E> samples()

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

create

T create(Object... elements)

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.

createArray

E[] createArray(int length)

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

order

Iterable<E> order(List<E> insertionOrder)

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.