Module nl.jqno.equalsverifier
Package nl.jqno.equalsverifier.api

Class RelaxedEqualsVerifierApi<T>

java.lang.Object
nl.jqno.equalsverifier.api.RelaxedEqualsVerifierApi<T>
public class RelaxedEqualsVerifierApi<T> extends Object
API class for EqualsVerifier.forRelaxedEqualExamples(Object, Object, Object...). Its purpose is to make sure, at compile time, that a list of unequal examples is given, as well as the list of equal examples that are supplied to the aforementioned method.
Since:
3.0

  • Field Details

    • type

      private final Class<T> type

    • equalExamples

      private final List<T> equalExamples

  • Constructor Details

    • RelaxedEqualsVerifierApi

      public RelaxedEqualsVerifierApi(Class<T> type, List<T> examples)
      Constructor.
      Parameters:
      type - The class for which the equals method should be tested.
      examples - A list of example instances that are equal but not identical to one another.
      Since:
      3.0

  • Method Details

    • andUnequalExample

      public SingleTypeEqualsVerifierApi<T> andUnequalExample(T example)
      Asks for an unequal instance of T and subsequently returns a fully constructed instance of EqualsVerifier.
      Parameters:
      example - An instance of T that is unequal to the previously supplied equal examples.
      Returns:
      An instance of EqualsVerifier.
      Since:
      0.4

    • andUnequalExamples

      @SafeVarargs public final SingleTypeEqualsVerifierApi<T> andUnequalExamples(T first, T... more)
      Asks for a list of unequal instances of T and subsequently returns a fully constructed instance of EqualsVerifier.
      Parameters:
      first - An instance of T that is unequal to the previously supplied equal examples.
      more - More instances of T, all of which are unequal to one another, to first, and to the previously supplied equal examples. May also contain instances of subclasses of T.
      Returns:
      An instance of EqualsVerifier.
      Since:
      0.4