Package org.fest.assertions.internal

Class Comparables

  • Direct Known Subclasses:
    Characters, Numbers
    public class Comparables
extends java.lang.Object
    Reusable assertions for Comparables.
    Author:
    Alex Ruiz, Joel Costigliola

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected <T> boolean areEqual​(T actual, T expected)  
      <T> void assertEqual​(AssertionInfo info, T actual, T expected)
      Asserts that two T instances are equal.
      <T extends java.lang.Comparable<? super T>>
      void      		 assertEqualByComparison​(AssertionInfo info, T actual, T expected)
      Asserts that two Comparables are equal by invoking Comparable.compareTo(Object).
      Note that it does not rely on the custom comparisonStrategy if one has been set.
      <T extends java.lang.Comparable<? super T>>
      void      		 assertGreaterThan​(AssertionInfo info, T actual, T other)
      Asserts that the actual value is greater than the other one.
      <T extends java.lang.Comparable<? super T>>
      void      		 assertGreaterThanOrEqualTo​(AssertionInfo info, T actual, T other)
      Asserts that the actual value is greater than or equal to the other one.
      <T extends java.lang.Comparable<? super T>>
      void      		 assertLessThan​(AssertionInfo info, T actual, T other)
      Asserts that the actual value is less than the other one.
      <T extends java.lang.Comparable<? super T>>
      void      		 assertLessThanOrEqualTo​(AssertionInfo info, T actual, T other)
      Asserts that the actual value is less than or equal to the other one.
      <T> void assertNotEqual​(AssertionInfo info, T actual, T other)
      Asserts that two T instances are not equal.
      <T extends java.lang.Comparable<? super T>>
      void      		 assertNotEqualByComparison​(AssertionInfo info, T actual, T other)
      Asserts that two Comparables are not equal by invoking Comparable.compareTo(Object) .
      Note that it does not rely on the custom comparisonStrategy if one has been set.
      protected static <T> void assertNotNull​(AssertionInfo info, T actual)  
      java.util.Comparator<?> getComparator()  
      static Comparables instance()
      Returns the singleton instance of this class based on StandardComparisonStrategy.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getComparator

        public java.util.Comparator<?> getComparator()

      • assertEqual

        public <T> void assertEqual​(AssertionInfo info,
                            T actual,
                            T expected)
        Asserts that two T instances are equal.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        expected - the expected value.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is not equal to the expected one. This method will throw a org.junit.ComparisonFailure instead if JUnit is in the classpath and the expected and actual values are not equal.

      • areEqual

        protected <T> boolean areEqual​(T actual,
                               T expected)

      • assertNotEqual

        public <T> void assertNotEqual​(AssertionInfo info,
                               T actual,
                               T other)
        Asserts that two T instances are not equal.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        other - the value to compare the actual value to.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is equal to the other one.

      • assertEqualByComparison

        public <T extends java.lang.Comparable<? super T>> void assertEqualByComparison​(AssertionInfo info,
                                                                                T actual,
                                                                                T expected)
        Asserts that two Comparables are equal by invoking Comparable.compareTo(Object).
        Note that it does not rely on the custom comparisonStrategy if one has been set.
        Type Parameters:
        T - used to guarantee that two objects of the same type are being compared against each other.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        expected - the expected value.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is not equal to the expected one. This method will throw a org.junit.ComparisonFailure instead if JUnit is in the classpath and the expected and actual values are not equal.

      • assertNotEqualByComparison

        public <T extends java.lang.Comparable<? super T>> void assertNotEqualByComparison​(AssertionInfo info,
                                                                                   T actual,
                                                                                   T other)
        Asserts that two Comparables are not equal by invoking Comparable.compareTo(Object) .
        Note that it does not rely on the custom comparisonStrategy if one has been set.
        Type Parameters:
        T - used to guarantee that two objects of the same type are being compared against each other.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        other - the value to compare the actual value to.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is equal to the other one.

      • assertLessThan

        public <T extends java.lang.Comparable<? super T>> void assertLessThan​(AssertionInfo info,
                                                                       T actual,
                                                                       T other)
        Asserts that the actual value is less than the other one.
        Type Parameters:
        T - used to guarantee that two objects of the same type are being compared against each other.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        other - the value to compare the actual value to.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is not less than the other one: this assertion will fail if the actual value is equal to or greater than the other value.

      • assertLessThanOrEqualTo

        public <T extends java.lang.Comparable<? super T>> void assertLessThanOrEqualTo​(AssertionInfo info,
                                                                                T actual,
                                                                                T other)
        Asserts that the actual value is less than or equal to the other one.
        Type Parameters:
        T - used to guarantee that two objects of the same type are being compared against each other.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        other - the value to compare the actual value to.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is greater than the other one.

      • assertGreaterThan

        public <T extends java.lang.Comparable<? super T>> void assertGreaterThan​(AssertionInfo info,
                                                                          T actual,
                                                                          T other)
        Asserts that the actual value is greater than the other one.
        Type Parameters:
        T - used to guarantee that two objects of the same type are being compared against each other.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        other - the value to compare the actual value to.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is not greater than the other one: this assertion will fail if the actual value is equal to or less than the other value.

      • assertGreaterThanOrEqualTo

        public <T extends java.lang.Comparable<? super T>> void assertGreaterThanOrEqualTo​(AssertionInfo info,
                                                                                   T actual,
                                                                                   T other)
        Asserts that the actual value is greater than or equal to the other one.
        Type Parameters:
        T - used to guarantee that two objects of the same type are being compared against each other.
        Parameters:
        info - contains information about the assertion.
        actual - the actual value.
        other - the value to compare the actual value to.
        Throws:
        java.lang.AssertionError - if the actual value is null.
        java.lang.AssertionError - if the actual value is less than the other one.

      • assertNotNull

        protected static <T> void assertNotNull​(AssertionInfo info,
                                        T actual)