Interface AddFirstContract<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 AddFirstContract<E,C extends SequencedCollection<E>> extends CollectionContractSupport<E,C>

This interface tests if a class has implemented the addFirst() method correctly based upon the specification in the SequencedCollection class. 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 addFirst 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.AddFirst);
    }
}
Since:
1.0
Author:
evanbergstrom
See Also:

  • Method Details

    • testAddFirst

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

    • testAddFirstWithNullValue

      @Test @DisplayName("The addFirst method works with null element values") default void testAddFirstWithNullValue()
      Tests that the addFirst method handles null values correctly.
      Throws:
      org.opentest4j.AssertionFailedError - if the test fails.
      See Also:

    • addFirstWithDuplicateValue

      @Test @DisplayName("The addFirst method works with duplicate element values") default void addFirstWithDuplicateValue()
      Tests that the addFirst method handles duplicate values correctly.
      Throws:
      org.opentest4j.AssertionFailedError - if the test fails.
      See Also: