org.assertj.core.api

Class AbstractComparableAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

java.lang.Object

org.assertj.core.api.AbstractAssert<S,A>

org.assertj.core.api.AbstractComparableAssert<S,A>

Type Parameters:

S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

A - the type of the "actual" value.

All Implemented Interfaces:

Assert<S,A>, ComparableAssert<S,A>, Descriptable<S>, ExtensionPoints<S,A>

Direct Known Subclasses:

AbstractByteAssert, AbstractCharacterAssert, AbstractDoubleAssert, AbstractFloatAssert, AbstractIntegerAssert, AbstractLongAssert, AbstractShortAssert, AbstractUnevenComparableAssert

public abstract class AbstractComparableAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>
extends AbstractAssert<S,A>
implements ComparableAssert<S,A>

Base class for all implementations of ComparableAssert.

Author:

Alex Ruiz, Mikhail Mazursky

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractComparableAssert(A actual, Class<?> selfType)

Method Summary

Methods

Modifier and Type	Method and Description
S	inBinary() Use binary object representation instead of standard representation in error messages.
S	inHexadecimal() Use hexadecimal object representation instead of standard representation in error messages.
S	isGreaterThan(A other) Verifies that the actual value is greater than the given one.
S	isGreaterThanOrEqualTo(A other) Verifies that the actual value is greater than or equal to the given one.
S	isLessThan(A other) Verifies that the actual value is less than the given one.
S	isLessThanOrEqualTo(A other) Verifies that the actual value is less than or equal to the given one.
S	usingComparator(Comparator<? super A> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
S	usingDefaultComparator() Revert to standard comparison for incoming assertion checks.

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractComparableAssert

protected AbstractComparableAssert(A actual,
                        Class<?> selfType)

Method Detail

isLessThan

public S isLessThan(A other)

Verifies that the actual value is less than the given one.

Specified by:

isLessThan in interface ComparableAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

isLessThanOrEqualTo

public S isLessThanOrEqualTo(A other)

Verifies that the actual value is less than or equal to the given one.

Specified by:

isLessThanOrEqualTo in interface ComparableAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

isGreaterThan

public S isGreaterThan(A other)

Verifies that the actual value is greater than the given one.

Specified by:

isGreaterThan in interface ComparableAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

isGreaterThanOrEqualTo

public S isGreaterThanOrEqualTo(A other)

Verifies that the actual value is greater than or equal to the given one.

Specified by:

isGreaterThanOrEqualTo in interface ComparableAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Parameters:

other - the given value to compare the actual value to.

Returns:

this assertion object.

usingComparator

public S usingComparator(Comparator<? super A> customComparator)

Description copied from class: AbstractAssert

Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.

Custom comparator is bound to assertion instance, meaning that if a new assertion is created, it will use default comparison strategy.

Examples :

 // frodo and sam are instances of Character with Hobbit race (obviously :).
 // raceComparator implements Comparator<Character> 
 assertThat(frodo).usingComparator(raceComparator).isEqualTo(sam); 
 

Specified by:

usingComparator in interface Assert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Overrides:

usingComparator in class AbstractAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultComparator

public S usingDefaultComparator()

Description copied from class: AbstractAssert

Revert to standard comparison for incoming assertion checks.

This method should be used to disable a custom comparison strategy set by calling Assert.usingComparator(Comparator).

Specified by:

usingDefaultComparator in interface Assert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Overrides:

usingDefaultComparator in class AbstractAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Returns:

this assertion object.

inHexadecimal

public S inHexadecimal()

Description copied from class: AbstractAssert

Use hexadecimal object representation instead of standard representation in error messages.

It can be useful when comparing UNICODE characters - many unicode chars have duplicate characters assigned, it is thus impossible to find differences from the standard error message:

With standard message:

 assertThat("µµµ").contains("μμμ");

 java.lang.AssertionError:
 Expecting:
   <"µµµ">
 to contain:
   <"μμμ">
 

With Hexadecimal message:

 assertThat("µµµ").inHexadecimal().contains("μμμ");

 java.lang.AssertionError:
 Expecting:
   <"['00B5', '00B5', '00B5']">
 to contain:
   <"['03BC', '03BC', '03BC']">
 

Overrides:

inHexadecimal in class AbstractAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Returns:

this assertion object.

inBinary

public S inBinary()

Description copied from class: AbstractAssert

Use binary object representation instead of standard representation in error messages.

Example:

 assertThat(1).inBinary().isEqualTo(2);

 org.junit.ComparisonFailure:
 Expected :0b00000000_00000000_00000000_00000010
 Actual   :0b00000000_00000000_00000000_00000001

Overrides:

inBinary in class AbstractAssert<S extends AbstractComparableAssert<S,A>,A extends Comparable<? super A>>

Returns:

this assertion object.