org.assertj.core.api

Interface ComparableAssert<S extends ComparableAssert<S,A>,A extends Comparable<? super 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 Known Implementing Classes:

AbstractBigDecimalAssert, AbstractByteAssert, AbstractCharacterAssert, AbstractComparableAssert, AbstractDoubleAssert, AbstractFloatAssert, AbstractIntegerAssert, AbstractIterableSizeAssert, AbstractLongAssert, AbstractMapSizeAssert, AbstractPathAssert, AbstractShortAssert, BigDecimalAssert, ByteAssert, CharacterAssert, DoubleAssert, FloatAssert, GenericComparableAssert, IntegerAssert, IterableSizeAssert, LongAssert, MapSizeAssert, PathAssert, ShortAssert

public interface ComparableAssert<S extends ComparableAssert<S,A>,A extends Comparable<? super A>>

Assertion methods applicable to Comparables.

Author:

Alex Ruiz, Ted M. Young, Mikhail Mazursky

Method Summary

Modifier and Type	Method and Description
S	isBetween(A startInclusive, A endInclusive) Verifies that the actual value is in [start, end] range (start included, end included).
S	isEqualByComparingTo(A other) Verifies that the actual value is equal to the given one by invoking Comparable.compareTo(Object).
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	isNotEqualByComparingTo(A other) Verifies that the actual value is not equal to the given one by invoking Comparable.compareTo(Object).
S	isStrictlyBetween(A startExclusive, A endExclusive) Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).

Method Detail

isEqualByComparingTo

S isEqualByComparingTo(A other)

Verifies that the actual value is equal to the given one by invoking Comparable.compareTo(Object).

Example:

 // assertion will pass
 assertThat(1.0).isEqualByComparingTo(1.0);
 // assertion will pass because 8.0 is equal to 8.00 using BigDecimal.compareTo(BigDecimal)
 assertThat(new BigDecimal("8.0")).isEqualByComparingTo(new BigDecimal("8.00"));

 // assertion will fail
 assertThat(new BigDecimal(1.0)).isEqualByComparingTo(new BigDecimal(2.0));

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is not equal when comparing to the given one.

isNotEqualByComparingTo

S isNotEqualByComparingTo(A other)

Verifies that the actual value is not equal to the given one by invoking Comparable.compareTo(Object).

Example:

 // assertion will pass
 assertThat(new BigDecimal(1.0)).isNotEqualByComparingTo(new BigDecimal(2.0));

 // assertion will fail
 assertThat(1.0).isNotEqualByComparingTo(1.0);
 // assertion will fail because 8.0 is equal to 8.00 using BigDecimal.compareTo(BigDecimal)
 assertThat(new BigDecimal("8.0")).isNotEqualByComparingTo(new BigDecimal("8.00"));

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is equal when comparing to the given one.

isLessThan

S isLessThan(A other)

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

Example:

 // assertions will pass
 assertThat('a').isLessThan('b');
 assertThat(BigInteger.ZERO).isLessThan(BigInteger.ONE);
 
 // assertions will fail
 assertThat('a').isLessThan('a');
 assertThat(BigInteger.ONE).isLessThan(BigInteger.ZERO);

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is equal to or greater than the given one.

isLessThanOrEqualTo

S isLessThanOrEqualTo(A other)

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

Example:

 // assertions will pass
 assertThat('a').isLessThanOrEqualTo('b');
 assertThat('a').isLessThanOrEqualTo('a');
 assertThat(BigInteger.ZERO).isLessThanOrEqualTo(BigInteger.ZERO);
 
 // assertions will fail
 assertThat('b').isLessThanOrEqualTo('a');
 assertThat(BigInteger.ONE).isLessThanOrEqualTo(BigInteger.ZERO);

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is greater than the given one.

isGreaterThan

S isGreaterThan(A other)

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

Example:

 // assertions will pass
 assertThat('b').isGreaterThan('a');
 assertThat(BigInteger.ONE).isGreaterThan(BigInteger.ZERO);
 
 // assertions will fail
 assertThat('b').isGreaterThan('a');
 assertThat(BigInteger.ZERO).isGreaterThan(BigInteger.ZERO);

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is equal to or less than the given one.

isGreaterThanOrEqualTo

S isGreaterThanOrEqualTo(A other)

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

Example:

 // assertions will pass
 assertThat('b').isGreaterThanOrEqualTo('a');
 assertThat(BigInteger.ONE).isGreaterThanOrEqualTo(BigInteger.ONE);
 
 // assertions will fail
 assertThat('a').isGreaterThanOrEqualTo('b');
 assertThat(BigInteger.ZERO).isGreaterThanOrEqualTo(BigInteger.ONE);

Parameters:

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

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

AssertionError - if the actual value is less than the given one.

isBetween

S isBetween(A startInclusive,
            A endInclusive)

Verifies that the actual value is in [start, end] range (start included, end included).

Example:

 // assertions succeed
 assertThat('b').isBetween('a', 'c');
 assertThat('a').isBetween('a', 'b');
 assertThat('b').isBetween('a', 'b');
 
 // assertions fail
 assertThat('a').isBetween('b', 'c');
 assertThat('c').isBetween('a', 'b');

Parameters:

startInclusive - the start value (inclusive), expected not to be null.

endInclusive - the end value (inclusive), expected not to be null.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

NullPointerException - if start value is null.

NullPointerException - if end value is null.

AssertionError - if the actual value is not in [start, end] range.

Since:

2.5.0 / 3.5.0

isStrictlyBetween

S isStrictlyBetween(A startExclusive,
                    A endExclusive)

Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).

Example:

 // assertion succeeds
 assertThat('b').isStrictlyBetween('a', 'c');
 
 // assertions fail
 assertThat('d').isStrictlyBetween('a', 'c');
 assertThat('a').isStrictlyBetween('b', 'd');
 assertThat('a').isStrictlyBetween('a', 'b');
 assertThat('b').isStrictlyBetween('a', 'b');

Parameters:

startExclusive - the start value (exclusive), expected not to be null.

endExclusive - the end value (exclusive), expected not to be null.

Returns:

this assertion object.

Throws:

AssertionError - if the actual value is null.

NullPointerException - if start value is null.

NullPointerException - if end value is null.

AssertionError - if the actual value is not in ]start, end[ range.

Since:

2.5.0 / 3.5.0