Package org.assertj.core.internal
Class Comparables
- java.lang.Object
-
- org.assertj.core.internal.Comparables
-
- Direct Known Subclasses:
Characters
,Numbers
public class Comparables extends Object
Reusable assertions for
s.Comparable
- Author:
- Alex Ruiz, Joel Costigliola
-
-
Field Summary
Fields Modifier and Type Field Description private ComparisonStrategy
comparisonStrategy
(package private) Failures
failures
-
Constructor Summary
Constructors Constructor Description Comparables()
Build aComparables
using aStandardComparisonStrategy
.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 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 Comparable<? super T>>
voidassertGreaterThan(AssertionInfo info, T actual, T other)
private <T extends Comparable<? super T>>
voidassertGreaterThan(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
Asserts that the actual value is greater than the other one.<T extends Comparable<? super T>>
voidassertGreaterThanOrEqualTo(AssertionInfo info, T actual, T other)
private <T extends Comparable<? super T>>
voidassertGreaterThanOrEqualTo(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
Asserts that the actual value is greater than or equal to the other one.<T extends Comparable<? super T>>
voidassertIsAfter(AssertionInfo info, T actual, T other)
<T extends Comparable<? super T>>
voidassertIsAfterOrEqualTo(AssertionInfo info, T actual, T other)
<T extends Comparable<? super T>>
voidassertIsBefore(AssertionInfo info, T actual, T other)
Asserts that the actual value is strictly before the other one.<T extends Comparable<? super T>>
voidassertIsBeforeOrEqualTo(AssertionInfo info, T actual, T other)
<T extends 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 Comparable<? super T>>
voidassertLessThan(AssertionInfo info, T actual, T other)
Asserts that the actual value is less than the other one.private <T extends Comparable<? super T>>
voidassertLessThan(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
Asserts that the actual value is less than the other one and throws an error with the given message factory.<T extends Comparable<? super T>>
voidassertLessThanOrEqualTo(AssertionInfo info, T actual, T other)
private <T extends Comparable<? super T>>
voidassertLessThanOrEqualTo(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
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 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)
protected <T extends Comparable<? super T>>
voidcheckBoundsValidity(T start, T end, boolean inclusiveStart, boolean inclusiveEnd)
boolean
equals(Object obj)
Comparator<?>
getComparator()
int
hashCode()
private boolean
isGreaterThan(Object actual, Object other)
private boolean
isLessThan(Object actual, Object other)
(package private) void
resetFailures()
(package private) void
setFailures(Failures failures)
String
toString()
-
-
-
Field Detail
-
comparisonStrategy
private final ComparisonStrategy comparisonStrategy
-
failures
Failures failures
-
-
Constructor Detail
-
Comparables
public Comparables()
Build aComparables
using aStandardComparisonStrategy
.
-
Comparables
public Comparables(ComparisonStrategy comparisonStrategy)
-
-
Method Detail
-
getComparator
public 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.- Type Parameters:
T
- the type of actual and expected- Parameters:
info
- contains information about the assertion.actual
- the actual value.expected
- the expected value.- Throws:
AssertionError
- if the actual value isnull
.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.- Type Parameters:
T
- the type of actual and expected- Parameters:
info
- contains information about the assertion.actual
- the actual value.other
- the value to compare the actual value to.- Throws:
AssertionError
- if the actual value isnull
.AssertionError
- if the actual value is equal to the other one.
-
assertEqualByComparison
public <T extends 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:
AssertionError
- if the actual value isnull
.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 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:
AssertionError
- if the actual value isnull
.AssertionError
- if the actual value is equal to the other one.
-
assertLessThan
public <T extends 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:
AssertionError
- if the actual value isnull
.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.
-
assertIsBefore
public <T extends Comparable<? super T>> void assertIsBefore(AssertionInfo info, T actual, T other)
Asserts that the actual value is strictly before 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:
AssertionError
- if the actual value isnull
.AssertionError
- if the actual value is not before the other one: this assertion will fail if the actual value is equal to or greater than the other value.
-
assertLessThan
private <T extends Comparable<? super T>> void assertLessThan(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
Asserts that the actual value is less than the other one and throws an error with the given message factory.- 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.errorMessageFactory
- the desired error message factory to generate the suitable error message- Throws:
AssertionError
- if the actual value isnull
.AssertionError
- if the actual value is not before the other one: this assertion will fail if the actual value is equal to or after the other value.
-
assertIsBeforeOrEqualTo
public <T extends Comparable<? super T>> void assertIsBeforeOrEqualTo(AssertionInfo info, T actual, T other)
-
assertLessThanOrEqualTo
public <T extends Comparable<? super T>> void assertLessThanOrEqualTo(AssertionInfo info, T actual, T other)
-
assertLessThanOrEqualTo
private <T extends Comparable<? super T>> void assertLessThanOrEqualTo(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
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.errorMessageFactory
- the desired error message factory to generate the suitable error message- Throws:
AssertionError
- if the actual value isnull
.AssertionError
- if the actual value is greater than the other one.
-
assertIsAfter
public <T extends Comparable<? super T>> void assertIsAfter(AssertionInfo info, T actual, T other)
-
assertGreaterThan
public <T extends Comparable<? super T>> void assertGreaterThan(AssertionInfo info, T actual, T other)
-
assertGreaterThan
private <T extends Comparable<? super T>> void assertGreaterThan(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
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.errorMessageFactory
- the desired error message factory to generate the suitable error message- Throws:
AssertionError
- if the actual value isnull
.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 Comparable<? super T>> void assertGreaterThanOrEqualTo(AssertionInfo info, T actual, T other)
-
assertIsAfterOrEqualTo
public <T extends Comparable<? super T>> void assertIsAfterOrEqualTo(AssertionInfo info, T actual, T other)
-
assertGreaterThanOrEqualTo
private <T extends Comparable<? super T>> void assertGreaterThanOrEqualTo(AssertionInfo info, T actual, T other, TriFunction<T,T,ComparisonStrategy,ErrorMessageFactory> errorMessageFactory)
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.errorMessageFactory
- the desired error message factory to generate the suitable error message- Throws:
AssertionError
- if the actual value isnull
.AssertionError
- if the actual value is less than the other one.
-
assertNotNull
protected static <T> void assertNotNull(AssertionInfo info, T actual)
-
assertIsBetween
public <T extends 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:
AssertionError
- if the actual value isnull
.AssertionError
- if the actual value is not between start and end.NullPointerException
- if start value isnull
.NullPointerException
- if end value isnull
.IllegalArgumentException
- if end value is less than start value.
-
checkBoundsValidity
protected <T extends Comparable<? super T>> void checkBoundsValidity(T start, T end, boolean inclusiveStart, boolean inclusiveEnd)
-
-