Interface GetFirstContract<E,C extends SequencedCollection<E>>

Type Parameters:
E - The element type being tested.
C - The collection type being tested.
All Superinterfaces:
CollectionContractConfig, CollectionContractSupport<E,C>, CollectionProviderSupport<E,C>, ContractSupport<C>, ElementProviderSupport<E>, ProviderSupport<C>, SupportedMethods
All Known Subinterfaces:
ListContract<E,L>, SequencedCollectionContract<E,C>
public interface GetFirstContract<E,C extends SequencedCollection<E>> extends CollectionContractSupport<E,C>

Test for the getFirst method in the SequencedCollection interface. This contract class can be used individually by a test class, but it is normally used through the SequencedCollectionContract class:

public class MyCollectionTest extends SequencedCollectionContract<Integer, MyCollection<Integer>> {
}

If a test is using the SequencedCollectionContract class, but the class being tested does not implement the getFirst method based upon the specification in the SequencedCollection class, then it can be omitted from the tests using the doesNotSupportMethod() method:

public class MyCollectionTest extends SequencedCollectionContract<Integer, MyCollection<Integer>> {
    public MyCollectionTest() {
        doesNotSupportMethod(CollectionMethods.GetFirst);
    }
}
Since:
1.0
Author:
evanbergstrom

  • Method Details

    • testGetFirst

      @DisplayName("Test that the getFirst method works") @Test default void testGetFirst()
      Tests that the getFirst method works.
      Throws:
      org.opentest4j.AssertionFailedError - if the test fails.
      See Also:

    • testGetFirstOnEmptyCollection

      @DisplayName("Test that the getFirst method throws for an empty collection") @Test default void testGetFirstOnEmptyCollection()
      Tests that the getFirst method works on an empty collection.
      Throws:
      org.opentest4j.AssertionFailedError - if the test fails.
      See Also: