Module com.github.robtimus.junit.support

Package com.github.robtimus.junit.support.test.collections

Interface IterableTests<T>

Type Parameters:

T - The element type of the iterable to test.

All Known Subinterfaces:

CollectionTests<T>, CollectionTests.ClearTests<T>, CollectionTests.ContainsAllTests<T>, CollectionTests.ContainsTests<T>, CollectionTests.RemoveAllTests<T>, CollectionTests.RemoveIfTests<T>, CollectionTests.RemoveTests<T>, CollectionTests.RetainAllTests<T>, CollectionTests.ToArrayTests<T>, CollectionTests.ToArrayWithGeneratorTests<T>, CollectionTests.ToObjectArrayTests<T>, IterableTests.ForEachTests<T>, ListTests<T>, ListTests.AddAllIndexedTests<T>, ListTests.AddAllTests<T>, ListTests.AddIndexedTests<T>, ListTests.AddTests<T>, ListTests.EqualsTests<T>, ListTests.GetTests<T>, ListTests.HashCodeTests<T>, ListTests.IndexOfTests<T>, ListTests.LastIndexOfTests<T>, ListTests.ListIteratorIndexedTests<T>, ListTests.RemoveIndexedTests<T>, ListTests.ReplaceAllTests<T>, ListTests.SetTests<T>, ListTests.SpliteratorTests<T>, ListTests.SubListTests<T>, MapTests.EntrySetTests<K,V>, MapTests.EntrySetTests.AddAllTests<K,V>, MapTests.EntrySetTests.AddTests<K,V>, MapTests.EntrySetTests.ClearTests<K,V>, MapTests.EntrySetTests.ContainsAllTests<K,V>, MapTests.EntrySetTests.ContainsTests<K,V>, MapTests.EntrySetTests.EqualsTests<K,V>, MapTests.EntrySetTests.ForEachTests<K,V>, MapTests.EntrySetTests.HashCodeTests<K,V>, MapTests.EntrySetTests.IteratorTests<K,V>, MapTests.EntrySetTests.IteratorTests.ForEachRemainingTests<K,V>, MapTests.EntrySetTests.IteratorTests.IterationTests<K,V>, MapTests.EntrySetTests.IteratorTests.RemoveTests<K,V>, MapTests.EntrySetTests.RemoveAllTests<K,V>, MapTests.EntrySetTests.RemoveIfTests<K,V>, MapTests.EntrySetTests.RemoveTests<K,V>, MapTests.EntrySetTests.RetainAllTests<K,V>, MapTests.EntrySetTests.SpliteratorTests<K,V>, MapTests.EntrySetTests.ToArrayTests<K,V>, MapTests.EntrySetTests.ToArrayWithGeneratorTests<K,V>, MapTests.EntrySetTests.ToObjectArrayTests<K,V>, MapTests.KeySetTests<K,V>, MapTests.KeySetTests.AddAllTests<K,V>, MapTests.KeySetTests.AddTests<K,V>, MapTests.KeySetTests.ClearTests<K,V>, MapTests.KeySetTests.ContainsAllTests<K,V>, MapTests.KeySetTests.ContainsTests<K,V>, MapTests.KeySetTests.EqualsTests<K,V>, MapTests.KeySetTests.ForEachTests<K,V>, MapTests.KeySetTests.HashCodeTests<K,V>, MapTests.KeySetTests.IteratorTests<K,V>, MapTests.KeySetTests.IteratorTests.ForEachRemainingTests<K,V>, MapTests.KeySetTests.IteratorTests.IterationTests<K,V>, MapTests.KeySetTests.IteratorTests.RemoveTests<K,V>, MapTests.KeySetTests.RemoveAllTests<K,V>, MapTests.KeySetTests.RemoveIfTests<K,V>, MapTests.KeySetTests.RemoveTests<K,V>, MapTests.KeySetTests.RetainAllTests<K,V>, MapTests.KeySetTests.SpliteratorTests<K,V>, MapTests.KeySetTests.ToArrayTests<K,V>, MapTests.KeySetTests.ToArrayWithGeneratorTests<K,V>, MapTests.KeySetTests.ToObjectArrayTests<K,V>, MapTests.ValuesTests<K,V>, MapTests.ValuesTests.AddAllTests<K,V>, MapTests.ValuesTests.AddTests<K,V>, MapTests.ValuesTests.ClearTests<K,V>, MapTests.ValuesTests.ContainsAllTests<K,V>, MapTests.ValuesTests.ContainsTests<K,V>, MapTests.ValuesTests.ForEachTests<K,V>, MapTests.ValuesTests.IteratorTests<K,V>, MapTests.ValuesTests.IteratorTests.ForEachRemainingTests<K,V>, MapTests.ValuesTests.IteratorTests.IterationTests<K,V>, MapTests.ValuesTests.IteratorTests.RemoveTests<K,V>, MapTests.ValuesTests.RemoveAllTests<K,V>, MapTests.ValuesTests.RemoveIfTests<K,V>, MapTests.ValuesTests.RemoveTests<K,V>, MapTests.ValuesTests.RetainAllTests<K,V>, MapTests.ValuesTests.ToArrayTests<K,V>, MapTests.ValuesTests.ToArrayWithGeneratorTests<K,V>, MapTests.ValuesTests.ToObjectArrayTests<K,V>, SetTests<T>, SetTests.AddAllTests<T>, SetTests.AddTests<T>, SetTests.EqualsTests<T>, SetTests.HashCodeTests<T>, SetTests.SpliteratorTests<T>, UnmodifiableCollectionTests<T>, UnmodifiableCollectionTests.AddAllTests<T>, UnmodifiableCollectionTests.AddTests<T>, UnmodifiableCollectionTests.ClearTests<T>, UnmodifiableCollectionTests.RemoveAllTests<T>, UnmodifiableCollectionTests.RemoveIfTests<T>, UnmodifiableCollectionTests.RemoveTests<T>, UnmodifiableCollectionTests.RetainAllTests<T>, UnmodifiableListTests<T>, UnmodifiableListTests.AddAllIndexedTests<T>, UnmodifiableListTests.AddIndexedTests<T>, UnmodifiableListTests.RemoveIndexedTests<T>, UnmodifiableListTests.ReplaceAllTests<T>, UnmodifiableListTests.SetTests<T>, UnmodifiableMapTests.EntrySetTests<K,V>, UnmodifiableMapTests.EntrySetTests.AddAllTests<K,V>, UnmodifiableMapTests.EntrySetTests.AddTests<K,V>, UnmodifiableMapTests.EntrySetTests.ClearTests<K,V>, UnmodifiableMapTests.EntrySetTests.ContainsAllTests<K,V>, UnmodifiableMapTests.EntrySetTests.ContainsTests<K,V>, UnmodifiableMapTests.EntrySetTests.EqualsTests<K,V>, UnmodifiableMapTests.EntrySetTests.ForEachTests<K,V>, UnmodifiableMapTests.EntrySetTests.HashCodeTests<K,V>, UnmodifiableMapTests.EntrySetTests.IteratorTests<K,V>, UnmodifiableMapTests.EntrySetTests.IteratorTests.ForEachRemainingTests<K,V>, UnmodifiableMapTests.EntrySetTests.IteratorTests.IterationTests<K,V>, UnmodifiableMapTests.EntrySetTests.IteratorTests.RemoveTests<K,V>, UnmodifiableMapTests.EntrySetTests.RemoveAllTests<K,V>, UnmodifiableMapTests.EntrySetTests.RemoveIfTests<K,V>, UnmodifiableMapTests.EntrySetTests.RemoveTests<K,V>, UnmodifiableMapTests.EntrySetTests.RetainAllTests<K,V>, UnmodifiableMapTests.EntrySetTests.SpliteratorTests<K,V>, UnmodifiableMapTests.EntrySetTests.ToArrayTests<K,V>, UnmodifiableMapTests.EntrySetTests.ToArrayWithGeneratorTests<K,V>, UnmodifiableMapTests.EntrySetTests.ToObjectArrayTests<K,V>, UnmodifiableMapTests.KeySetTests<K,V>, UnmodifiableMapTests.KeySetTests.AddAllTests<K,V>, UnmodifiableMapTests.KeySetTests.AddTests<K,V>, UnmodifiableMapTests.KeySetTests.ClearTests<K,V>, UnmodifiableMapTests.KeySetTests.ContainsAllTests<K,V>, UnmodifiableMapTests.KeySetTests.ContainsTests<K,V>, UnmodifiableMapTests.KeySetTests.EqualsTests<K,V>, UnmodifiableMapTests.KeySetTests.ForEachTests<K,V>, UnmodifiableMapTests.KeySetTests.HashCodeTests<K,V>, UnmodifiableMapTests.KeySetTests.IteratorTests<K,V>, UnmodifiableMapTests.KeySetTests.IteratorTests.ForEachRemainingTests<K,V>, UnmodifiableMapTests.KeySetTests.IteratorTests.IterationTests<K,V>, UnmodifiableMapTests.KeySetTests.IteratorTests.RemoveTests<K,V>, UnmodifiableMapTests.KeySetTests.RemoveAllTests<K,V>, UnmodifiableMapTests.KeySetTests.RemoveIfTests<K,V>, UnmodifiableMapTests.KeySetTests.RemoveTests<K,V>, UnmodifiableMapTests.KeySetTests.RetainAllTests<K,V>, UnmodifiableMapTests.KeySetTests.SpliteratorTests<K,V>, UnmodifiableMapTests.KeySetTests.ToArrayTests<K,V>, UnmodifiableMapTests.KeySetTests.ToArrayWithGeneratorTests<K,V>, UnmodifiableMapTests.KeySetTests.ToObjectArrayTests<K,V>, UnmodifiableMapTests.ValuesTests<K,V>, UnmodifiableMapTests.ValuesTests.AddAllTests<K,V>, UnmodifiableMapTests.ValuesTests.AddTests<K,V>, UnmodifiableMapTests.ValuesTests.ClearTests<K,V>, UnmodifiableMapTests.ValuesTests.ContainsAllTests<K,V>, UnmodifiableMapTests.ValuesTests.ContainsTests<K,V>, UnmodifiableMapTests.ValuesTests.ForEachTests<K,V>, UnmodifiableMapTests.ValuesTests.IteratorTests<K,V>, UnmodifiableMapTests.ValuesTests.IteratorTests.ForEachRemainingTests<K,V>, UnmodifiableMapTests.ValuesTests.IteratorTests.IterationTests<K,V>, UnmodifiableMapTests.ValuesTests.IteratorTests.RemoveTests<K,V>, UnmodifiableMapTests.ValuesTests.RemoveAllTests<K,V>, UnmodifiableMapTests.ValuesTests.RemoveIfTests<K,V>, UnmodifiableMapTests.ValuesTests.RemoveTests<K,V>, UnmodifiableMapTests.ValuesTests.RetainAllTests<K,V>, UnmodifiableMapTests.ValuesTests.ToArrayTests<K,V>, UnmodifiableMapTests.ValuesTests.ToArrayWithGeneratorTests<K,V>, UnmodifiableMapTests.ValuesTests.ToObjectArrayTests<K,V>, UnmodifiableSetTests<T>

public interface IterableTests<T>

Base interface for testing separate Iterable functionalities.

Author:

Rob Spoor

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IterableTests.ForEachTests<T>	Contains tests for Iterable.forEach(Consumer).

Method Summary

Modifier and Type	Method	Description
Collection<T>	expectedElements()	Returns the expected elements contained by the iterable to test.
boolean	fixedOrder()	Returns whether or not the iterable to test has a fixed order.
Iterable<T>	iterable()	Returns the iterable to test.

Method Detail

iterable

Iterable<T> iterable()

Returns the iterable to test. This should be populated, i.e. not empty, unless the iterable can only be empty.

This method will be called only once for each test. This makes it possible to initialize the iterable in a method annotated with BeforeEach, and perform additional tests after the pre-defined test has finished.

Returns:

The iterable to test.

expectedElements

Collection<T> expectedElements()

Returns the expected elements contained by the iterable to test. This should not be of the same type as the iterable to test, but preferably of some well-known iterable type like ArrayList or HashSet.

Returns:

The expected elements contained by the iterable to test.

fixedOrder

boolean fixedOrder()

Returns whether or not the iterable to test has a fixed order.

Returns:

true if the iterable to test has a fixed order, or false if the order is unspecified.