org.assertj.core.api

Class AbstractIntegerAssert<S extends AbstractIntegerAssert<S>>

java.lang.Object

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

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

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

org.assertj.core.api.AbstractIntegerAssert<S>

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.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractIterableSizeAssert, AbstractMapSizeAssert, IntegerAssert

public abstract class AbstractIntegerAssert<S extends AbstractIntegerAssert<S>>
extends AbstractComparableAssert<S,Integer>
implements NumberAssert<S,Integer>

Base class for all implementations of assertions for Integers.

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

Constructor and Description
AbstractIntegerAssert(Integer actual, Class<?> selfType)

Method Summary

Modifier and Type	Method and Description
S	isBetween(Integer start, Integer end) Verifies that the actual value is in [start, end] range (start included, end included).
S	isCloseTo(Integer expected, Offset<Integer> offset) Verifies that the actual int is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
S	isCloseTo(Integer expected, Percentage percentage) Verifies that the actual number is close to the given one within the given percentage. If difference is equal to the percentage value, assertion is considered valid.
S	isCloseTo(int expected, Offset<Integer> offset) Verifies that the actual int is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
S	isCloseTo(int expected, Percentage percentage) Verifies that the actual number is close to the given one within the given percentage. If difference is equal to the percentage value, assertion is considered valid.
S	isEqualTo(int expected) Verifies that the actual value is equal to the given one.
S	isGreaterThan(int other) Verifies that the actual value is greater than the given one.
S	isGreaterThanOrEqualTo(int other) Verifies that the actual value is greater than or equal to the given one.
S	isLessThan(int other) Verifies that the actual value is less than the given one.
S	isLessThanOrEqualTo(int other) Verifies that the actual value is less than or equal to the given one.
S	isNegative() Verifies that the actual value is negative.
S	isNotCloseTo(Integer expected, Offset<Integer> offset) Verifies that the actual int is not close to the given one by less than the given offset. If the difference is equal to the offset value, the assertion fails.
S	isNotCloseTo(Integer expected, Percentage percentage) Verifies that the actual number is not close to the given one by the given percentage. If difference is equal to the percentage value, the assertion fails.
S	isNotCloseTo(int expected, Offset<Integer> offset) Verifies that the actual int is not close to the given one by less than the given offset. If the difference is equal to the offset value, the assertion fails.
S	isNotCloseTo(int expected, Percentage percentage) Verifies that the actual number is not close to the given one by the given percentage. If difference is equal to the percentage value, the assertion fails.
S	isNotEqualTo(int other) Verifies that the actual value is not equal to the given one.
S	isNotNegative() Verifies that the actual value is non negative (positive or equal zero).
S	isNotPositive() Verifies that the actual value is non positive (negative or equal zero).
S	isNotZero() Verifies that the actual value is not equal to zero.
S	isPositive() Verifies that the actual value is positive.
S	isStrictlyBetween(Integer start, Integer end) Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).
S	isZero() Verifies that the actual value is equal to zero.
S	usingComparator(Comparator<? super Integer> 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.AbstractComparableAssert

inBinary, inHexadecimal, isEqualByComparingTo, isGreaterThan, isGreaterThanOrEqualTo, isLessThan, isLessThanOrEqualTo, isNotEqualByComparingTo

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

as, as, defaultTypeComparators, extracting, extracting, hasFieldOrProperty, hasFieldOrPropertyWithValue, hasNoNullFieldsOrProperties, hasNoNullFieldsOrPropertiesExcept, isEqualToComparingFieldByField, isEqualToComparingFieldByFieldRecursively, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields, usingComparatorForFields, usingComparatorForType

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

asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasToString, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, overridingErrorMessage, satisfies, setCustomRepresentation, throwAssertionError, withFailMessage, withRepresentation, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIntegerAssert

public AbstractIntegerAssert(Integer actual,
                             Class<?> selfType)

Method Detail

isEqualTo

public S isEqualTo(int expected)

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

Example:

 // assertions will pass:
 assertThat(1).isEqualTo(1);
 assertThat(-1).isEqualTo(-1);
 
 // assertions will fail:
 assertThat(1).isEqualTo(2);
 assertThat(1).isEqualTo(-1);

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 S isNotEqualTo(int other)

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

Example:

 // assertions will pass:
 assertThat(1).isNotEqualTo(2);
 assertThat(1).isNotEqualTo(-1);
 
 // assertion will fail:
 assertThat(1).isNotEqualTo(1);

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 S isZero()

Verifies that the actual value is equal to zero.

Example:

 // assertions will pass
 assertThat(0).isZero();
 assertThat(0.0).isZero();

 // assertions will fail
 assertThat(42).isZero();
 assertThat(3.142).isZero();

Specified by:

isZero in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Returns:

this assertion object.

isNotZero

public S isNotZero()

Verifies that the actual value is not equal to zero.

Example:

 // assertions will pass
 assertThat(42).isNotZero();
 assertThat(3.142).isNotZero();

 // assertions will fail
 assertThat(0).isNotZero();
 assertThat(0.0).isNotZero();

Specified by:

isNotZero in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Returns:

this assertion object.

isPositive

public S isPositive()

Verifies that the actual value is positive.

Example:

 // assertions will pass
 assertThat(42).isPositive();
 assertThat(3.142).isPositive();

 // assertions will fail
 assertThat(0).isPositive();
 assertThat(-42).isPositive();

Specified by:

isPositive in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Returns:

this assertion object.

isNegative

public S isNegative()

Verifies that the actual value is negative.

Example:

 // assertions will pass
 assertThat(-42).isNegative();
 assertThat(-3.124).isNegative();

 // assertions will fail
 assertThat(0).isNegative();
 assertThat(42).isNegative();

Specified by:

isNegative in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Returns:

this assertion object.

isNotNegative

public S isNotNegative()

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

Example:

 // assertions will pass
 assertThat(42).isNotNegative();
 assertThat(0).isNotNegative();

 // assertions will fail
 assertThat(-42).isNotNegative();
 assertThat(-3.124).isNotNegative();

Specified by:

isNotNegative in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Returns:

this assertion object.

isNotPositive

public S isNotPositive()

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

Example:

 // assertions will pass
 assertThat(-42).isNotPositive();
 assertThat(0).isNotPositive();

 // assertions will fail
 assertThat(42).isNotPositive();
 assertThat(3.124).isNotPositive();

Specified by:

isNotPositive in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Returns:

this assertion object.

isLessThan

public S isLessThan(int other)

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

Example:

 // assertions will pass:
 assertThat(1).isLessThan(2);
 assertThat(-2).isLessThan(-1);
 
 // assertions will fail:
 assertThat(1).isLessThan(0);
 assertThat(1).isLessThan(1);

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 S isLessThanOrEqualTo(int other)

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

Example:

 // assertions will pass:
 assertThat(1).isLessThanOrEqualTo(2);
 assertThat(-1).isLessThanOrEqualTo(-2);
 assertThat(1).isLessThanOrEqualTo(1);
 
 // assertions will fail:
 assertThat(1).isLessThanOrEqualTo(2);
 assertThat(-1).isLessThanOrEqualTo(-2);

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 S isGreaterThan(int other)

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

Example:

 // assertions will pass:
 assertThat(1).isGreaterThan(0);
 assertThat(-1).isGreaterThan(-2);
 
 // assertions will fail:
 assertThat(1).isGreaterThan(2);
 assertThat(1).isGreaterThan(1);

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 S isGreaterThanOrEqualTo(int other)

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

Example:

 // assertions will pass:
 assertThat(2).isGreaterThanOrEqualTo(1);
 assertThat(1).isGreaterThanOrEqualTo(1);
 
 // assertions will fail:
 assertThat(1).isGreaterThanOrEqualTo(2);
 assertThat(-1).isGreaterThanOrEqualTo(1);

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

public S isBetween(Integer start,
                   Integer end)

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');

Specified by:

isBetween in interface ComparableAssert<S extends AbstractIntegerAssert<S>,Integer>

Specified by:

isBetween in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Overrides:

isBetween in class AbstractComparableAssert<S extends AbstractIntegerAssert<S>,Integer>

Parameters:

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

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

Returns:

this assertion object.

isStrictlyBetween

public S isStrictlyBetween(Integer start,
                           Integer end)

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');

Specified by:

isStrictlyBetween in interface ComparableAssert<S extends AbstractIntegerAssert<S>,Integer>

Specified by:

isStrictlyBetween in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Overrides:

isStrictlyBetween in class AbstractComparableAssert<S extends AbstractIntegerAssert<S>,Integer>

Parameters:

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

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

Returns:

this assertion object.

isCloseTo

public S isCloseTo(int expected,
                   Offset<Integer> offset)

Verifies that the actual int is close to the given one within the given offset.
If difference is equal to offset value, assertion is considered valid.

Example:

 // assertions will pass:
 assertThat(5).isCloseTo(7, within(3));

 // if difference is exactly equals to the offset, it's ok
 assertThat(5).isCloseTo(7, within(2));

 // assertion will fail
 assertThat(5).isCloseTo(7, within(1));

Parameters:

expected - the given int to compare the actual value to.

offset - the given positive offset.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

AssertionError - if the actual value is not close to the given one.

isNotCloseTo

public S isNotCloseTo(int expected,
                      Offset<Integer> offset)

Verifies that the actual int is not close to the given one by less than the given offset.
If the difference is equal to the offset value, the assertion fails.

Example:

 // assertion will pass:
 assertThat(5).isNotCloseTo(7, byLessThan(1));

 // assertions will fail
 assertThat(5).isNotCloseTo(7, byLessThan(2));
 assertThat(5).isNotCloseTo(7, byLessThan(3));

Parameters:

expected - the given int to compare the actual value to.

offset - the given positive offset.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

AssertionError - if the actual value is close to the given one.

Since:

2.6.0 / 3.6.0

See Also:

Assertions.byLessThan(Integer)

isCloseTo

public S isCloseTo(Integer expected,
                   Offset<Integer> offset)

Verifies that the actual int is close to the given one within the given offset.
If difference is equal to offset value, assertion is considered valid.

Example:

 // assertions will pass:
 assertThat(5).isCloseTo(Integer.valueOf(7), within(3));

 // if difference is exactly equals to the offset, it's ok
 assertThat(5).isCloseTo(Integer.valueOf(7), within(2));

 // assertion will fail
 assertThat(5).isCloseTo(Integer.valueOf(7), within(1));

Specified by:

isCloseTo in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Parameters:

expected - the given int to compare the actual value to.

offset - the given positive offset.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

AssertionError - if the actual value is not close to the given one.

isNotCloseTo

public S isNotCloseTo(Integer expected,
                      Offset<Integer> offset)

Verifies that the actual int is not close to the given one by less than the given offset.
If the difference is equal to the offset value, the assertion fails.

Example:

 // assertion will pass:
 assertThat(5).isNotCloseTo(Integer.valueOf(7), byLessThan(1));

 // assertions will fail
 assertThat(5).isNotCloseTo(Integer.valueOf(7), byLessThan(2));
 assertThat(5).isNotCloseTo(Integer.valueOf(7), byLessThan(3));

Specified by:

isNotCloseTo in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Parameters:

expected - the given int to compare the actual value to.

offset - the given positive offset.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

AssertionError - if the actual value is close to the given one.

Since:

2.6.0 / 3.6.0

See Also:

Assertions.byLessThan(Integer)

isCloseTo

public S isCloseTo(Integer expected,
                   Percentage percentage)

Verifies that the actual number is close to the given one within the given percentage.
If difference is equal to the percentage value, assertion is considered valid.

Example with integer:

 // assertions will pass:
 assertThat(11).isCloseTo(Integer.valueOf(10), withinPercentage(20));

 // if difference is exactly equals to the computed offset (1), it's ok
 assertThat(11).isCloseTo(Integer.valueOf(10), withinPercentage(10));

 // assertion will fail
 assertThat(11).isCloseTo(Integer.valueOf(10), withinPercentage(5));

Specified by:

isCloseTo in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Parameters:

expected - the given number to compare the actual value to.

percentage - the given positive percentage.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

NullPointerException - if the expected number is null.

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

isNotCloseTo

public S isNotCloseTo(Integer expected,
                      Percentage percentage)

Verifies that the actual number is not close to the given one by the given percentage.
If difference is equal to the percentage value, the assertion fails.

Example with integer:

 // assertion will pass:
 assertThat(11).isNotCloseTo(Integer.valueOf(10), withinPercentage(5));

 // assertions will fail
 assertThat(11).isNotCloseTo(Integer.valueOf(10), withinPercentage(10));
 assertThat(11).isNotCloseTo(Integer.valueOf(10), withinPercentage(20));

Specified by:

isNotCloseTo in interface NumberAssert<S extends AbstractIntegerAssert<S>,Integer>

Parameters:

expected - the given number to compare the actual value to.

percentage - the given positive percentage.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

NullPointerException - if the expected number is null.

AssertionError - if the actual value is close to the given one.

Since:

2.6.0 / 3.6.0

isCloseTo

public S isCloseTo(int expected,
                   Percentage percentage)

Verifies that the actual number is close to the given one within the given percentage.
If difference is equal to the percentage value, assertion is considered valid.

Example with integer:

 // assertions will pass:
 assertThat(11).isCloseTo(10, withinPercentage(20));

 // if difference is exactly equals to the computed offset (1), it's ok
 assertThat(11).isCloseTo(10, withinPercentage(10));

 // assertion will fail
 assertThat(11).isCloseTo(10, withinPercentage(5));

Parameters:

expected - the given number to compare the actual value to.

percentage - the given positive percentage.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

NullPointerException - if the expected number is null.

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

isNotCloseTo

public S isNotCloseTo(int expected,
                      Percentage percentage)

Verifies that the actual number is not close to the given one by the given percentage.
If difference is equal to the percentage value, the assertion fails.

Example with integer:

 // assertion will pass:
 assertThat(11).isNotCloseTo(10, withinPercentage(5));

 // assertions will fail
 assertThat(11).isNotCloseTo(10, withinPercentage(10));
 assertThat(11).isNotCloseTo(10, withinPercentage(20));

Parameters:

expected - the given number to compare the actual value to.

percentage - the given positive percentage.

Returns:

this assertion object.

Throws:

NullPointerException - if the given offset is null.

NullPointerException - if the expected number is null.

AssertionError - if the actual value is close to the given one.

Since:

2.6.0 / 3.6.0

usingComparator

public S 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<S extends AbstractIntegerAssert<S>,Integer>

Overrides:

usingComparator in class AbstractComparableAssert<S extends AbstractIntegerAssert<S>,Integer>

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 AbstractIntegerAssert<S>,Integer>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<S extends AbstractIntegerAssert<S>,Integer>

Returns:

this assertion object.