Package org.assertj.core.internal
Class Comparables
- java.lang.Object
-
- org.assertj.core.internal.Comparables
-
- Direct Known Subclasses:
Characters
,Numbers
public class Comparables extends java.lang.Object
Reusable assertions for
s.Comparable
-
-
Field Summary
Fields Modifier and Type Field Description (package private) ComparisonStrategy
comparisonStrategy
(package private) Failures
failures
private static Comparables
INSTANCE
-
Constructor Summary
Constructors Constructor Description Comparables()
Comparables(ComparisonStrategy comparisonStrategy)
-
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>>
voidassertEqualByComparison(AssertionInfo info, T actual, T expected)
Asserts that two
s are equal by invokingComparable
.Comparable.compareTo(Object)
Note that it does not rely on the customcomparisonStrategy
if one has been set.<T extends java.lang.Comparable<? super T>>
voidassertGreaterThan(AssertionInfo info, T actual, T other)
Asserts that the actual value is greater than the other one.<T extends java.lang.Comparable<? super T>>
voidassertGreaterThanOrEqualTo(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>>
voidassertIsBetween(AssertionInfo info, T actual, T start, T end, boolean inclusiveStart, boolean inclusiveEnd)
Asserts that the actual value is between start and end, inclusive or not.<T extends java.lang.Comparable<? super T>>
voidassertLessThan(AssertionInfo info, T actual, T other)
Asserts that the actual value is less than the other one.<T extends java.lang.Comparable<? super T>>
voidassertLessThanOrEqualTo(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>>
voidassertNotEqualByComparison(AssertionInfo info, T actual, T other)
Asserts that two
s are not equal by invokingComparable
.Comparable.compareTo(Object)
Note that it does not rely on the customcomparisonStrategy
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 onStandardComparisonStrategy
.private boolean
isGreaterThan(java.lang.Object actual, java.lang.Object other)
delegates to {@link #comparisonStrategy#isGreaterThan(Object, Object)}private boolean
isLessThan(java.lang.Object actual, java.lang.Object other)
(package private) void
resetFailures()
(package private) void
setFailures(Failures failures)
-
-
-
Field Detail
-
INSTANCE
private static final Comparables INSTANCE
-
failures
Failures failures
-
comparisonStrategy
final ComparisonStrategy comparisonStrategy
-
-
Constructor Detail
-
Comparables
public Comparables()
-
Comparables
public Comparables(ComparisonStrategy comparisonStrategy)
-
-
Method Detail
-
instance
public static Comparables instance()
Returns the singleton instance of this class based onStandardComparisonStrategy
.- Returns:
- the singleton instance of this class based on
StandardComparisonStrategy
.
-
getComparator
public java.util.Comparator<?> getComparator()
-
setFailures
void setFailures(Failures failures)
-
resetFailures
void resetFailures()
-
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 isnull
.java.lang.AssertionError
- if the actual value is not equal to the expected one. This method will throw aorg.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 isnull
.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
s are equal by invokingComparable
.Comparable.compareTo(Object)
Note that it does not rely on the customcomparisonStrategy
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 isnull
.java.lang.AssertionError
- if the actual value is not equal to the expected one. This method will throw aorg.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
s are not equal by invokingComparable
.Comparable.compareTo(Object)
Note that it does not rely on the customcomparisonStrategy
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 isnull
.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 isnull
.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 isnull
.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 isnull
.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.
-
isGreaterThan
private boolean isGreaterThan(java.lang.Object actual, java.lang.Object other)
delegates to {@link #comparisonStrategy#isGreaterThan(Object, Object)}
-
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 isnull
.java.lang.AssertionError
- if the actual value is less than the other one.
-
isLessThan
private boolean isLessThan(java.lang.Object actual, java.lang.Object other)
-
assertNotNull
protected static <T> void assertNotNull(AssertionInfo info, T actual)
-
assertIsBetween
public <T extends java.lang.Comparable<? super T>> void assertIsBetween(AssertionInfo info, T actual, T start, T end, boolean inclusiveStart, boolean inclusiveEnd)
Asserts that the actual value is between start and end, inclusive or not.- 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.start
- the start value.end
- the end value.inclusiveStart
- if start is inclusive (fail is actual == start and inclusiveStart is false).inclusiveEnd
- if end is inclusive (fail is actual == end and inclusiveEnd is false).- Throws:
java.lang.AssertionError
- if the actual value isnull
.java.lang.AssertionError
- if the actual value is not between start and end.java.lang.NullPointerException
- if start value isnull
.java.lang.NullPointerException
- if end value isnull
.
-
-