org.assertj.core.api

Class IntegerAssert

java.lang.Object

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

org.assertj.core.api.AbstractComparableAssert<IntegerAssert,Integer>

org.assertj.core.api.IntegerAssert

All Implemented Interfaces:

Assert<IntegerAssert,Integer>, ComparableAssert<IntegerAssert,Integer>, Descriptable<IntegerAssert>, ExtensionPoints<IntegerAssert,Integer>, NumberAssert<Integer>

public class IntegerAssert
extends AbstractComparableAssert<IntegerAssert,Integer>
implements NumberAssert<Integer>

Assertion methods for integers.

To create an instance of this class, invoke Assertions.assertThat(Integer) or Assertions.assertThat(int).

Author:

Yvonne Wang, David DIDIER, Ansgar Konermann, Alex Ruiz, Joel Costigliola, Mikhail Mazursky, Nicolas François

Field Summary

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

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IntegerAssert(Integer actual)

Method Summary

Methods

Modifier and Type	Method and Description
IntegerAssert	isEqualTo(int expected) Verifies that the actual value is equal to the given one.
IntegerAssert	isGreaterThan(int other) Verifies that the actual value is greater than the given one.
IntegerAssert	isGreaterThanOrEqualTo(int other) Verifies that the actual value is greater than or equal to the given one.
IntegerAssert	isLessThan(int other) Verifies that the actual value is less than the given one.
IntegerAssert	isLessThanOrEqualTo(int other) Verifies that the actual value is less than or equal to the given one.
IntegerAssert	isNegative() Verifies that the actual value is negative.
IntegerAssert	isNotEqualTo(int other) Verifies that the actual value is not equal to the given one.
IntegerAssert	isNotNegative() Verifies that the actual value is non negative (positive or equal zero).
IntegerAssert	isNotPositive() Verifies that the actual value is non positive (negative or equal zero).
IntegerAssert	isNotZero() Verifies that the actual value is not equal to zero.
IntegerAssert	isPositive() Verifies that the actual value is positive.
IntegerAssert	isZero() Verifies that the actual value is equal to zero.
IntegerAssert	usingComparator(Comparator<? super Integer> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
IntegerAssert	usingDefaultComparator() Revert to standard comparison for incoming assertion checks.

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

isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo

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

IntegerAssert

protected IntegerAssert(Integer actual)

Method Detail

isEqualTo

public IntegerAssert isEqualTo(int expected)

Verifies that the actual value is equal to the given one.

Parameters:

expected - 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 to the given one.

isNotEqualTo

public IntegerAssert isNotEqualTo(int other)

Verifies that the actual value is not equal to the given 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 equal to the given one.

isZero

public IntegerAssert isZero()

Verifies that the actual value is equal to zero.

Specified by:

isZero in interface NumberAssert<Integer>

Returns:

this assertion object.

isNotZero

public IntegerAssert isNotZero()

Verifies that the actual value is not equal to zero.

Specified by:

isNotZero in interface NumberAssert<Integer>

Returns:

this assertion object.

isPositive

public IntegerAssert isPositive()

Verifies that the actual value is positive.

Specified by:

isPositive in interface NumberAssert<Integer>

Returns:

this assertion object.

isNegative

public IntegerAssert isNegative()

Verifies that the actual value is negative.

Specified by:

isNegative in interface NumberAssert<Integer>

Returns:

this assertion object.

isNotNegative

public IntegerAssert isNotNegative()

Verifies that the actual value is non negative (positive or equal zero).

Specified by:

isNotNegative in interface NumberAssert<Integer>

Returns:

this assertion object.

isNotPositive

public IntegerAssert isNotPositive()

Verifies that the actual value is non positive (negative or equal zero).

Specified by:

isNotPositive in interface NumberAssert<Integer>

Returns:

this assertion object.

isLessThan

public IntegerAssert isLessThan(int other)

Verifies that the actual value is less than the given 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 equal to or greater than the given one.

isLessThanOrEqualTo

public IntegerAssert isLessThanOrEqualTo(int other)

Verifies that the actual value is less than or equal to the given 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 greater than the given one.

isGreaterThan

public IntegerAssert isGreaterThan(int other)

Verifies that the actual value is greater than the given 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 equal to or less than the given one.

isGreaterThanOrEqualTo

public IntegerAssert isGreaterThanOrEqualTo(int other)

Verifies that the actual value is greater than or equal to the given 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.

usingComparator

public IntegerAssert usingComparator(Comparator<? super Integer> 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<IntegerAssert,Integer>

Overrides:

usingComparator in class AbstractComparableAssert<IntegerAssert,Integer>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultComparator

public IntegerAssert 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<IntegerAssert,Integer>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<IntegerAssert,Integer>

Returns:

this assertion object.