Package org.assertj.core.api
Class AbstractIntegerAssert<SELF extends AbstractIntegerAssert<SELF>>
java.lang.Object
org.assertj.core.api.AbstractAssert<SELF,Integer>
org.assertj.core.api.AbstractObjectAssert<SELF,Integer>
org.assertj.core.api.AbstractComparableAssert<SELF,Integer>
org.assertj.core.api.AbstractIntegerAssert<SELF>
- Type Parameters:
SELF
- 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<SELF,
,Integer> ComparableAssert<SELF,
,Integer> Descriptable<SELF>
,ExtensionPoints<SELF,
,Integer> NumberAssert<SELF,
Integer>
- Direct Known Subclasses:
AbstractIterableSizeAssert
,AbstractMapSizeAssert
,IntegerAssert
public abstract class AbstractIntegerAssert<SELF extends AbstractIntegerAssert<SELF>>
extends AbstractComparableAssert<SELF,Integer>
implements NumberAssert<SELF,Integer>
Base class for all implementations of assertions for
Integer
s.-
Field Summary
FieldsFields inherited from class org.assertj.core.api.AbstractComparableAssert
comparables
Fields inherited from class org.assertj.core.api.AbstractAssert
actual, conditions, info, myself, objects
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionVerifies that the actual value is in [start, end] range (start included, end included).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.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.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.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.isEqualTo
(int expected) Verifies that the actual value is equal to the given one.isGreaterThan
(int other) Verifies that the actual value is greater than the given one.isGreaterThanOrEqualTo
(int other) Verifies that the actual value is greater than or equal to the given one.isLessThan
(int other) Verifies that the actual value is less than the given one.isLessThanOrEqualTo
(int other) Verifies that the actual value is less than or equal to the given one.Verifies that the actual value is negative.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.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.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.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.isNotEqualTo
(int other) Verifies that the actual value is not equal to the given one.Verifies that the actual value is non negative (positive or equal zero).Verifies that the actual value is non positive (negative or equal zero).Verifies that the actual value is not equal to zero.isOne()
Verifies that the actual value is equal to one.Verifies that the actual value is positive.isStrictlyBetween
(Integer start, Integer end) Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).isZero()
Verifies that the actual value is equal to zero.usingComparator
(Comparator<? super Integer> customComparator) Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.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, returns, 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
-
Field Details
-
integers
Integers integers
-
-
Constructor Details
-
AbstractIntegerAssert
-
-
Method Details
-
isEqualTo
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 isnull
.AssertionError
- if the actual value is not equal to the given one.
-
isNotEqualTo
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 isnull
.AssertionError
- if the actual value is equal to the given one.
-
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
- this assertion object.
-
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
- this assertion object.
-
isOne
Verifies that the actual value is equal to one.Example:
// assertions will pass assertThat(1).isOne(); assertThat(1.0).isOne(); // assertions will fail assertThat(42).isOne(); assertThat(3.142).isOne();
- Specified by:
isOne
in interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
- this assertion object.
-
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
- this assertion object.
-
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
- this assertion object.
-
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
this
assertion object.
-
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
this
assertion object.
-
isLessThan
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 isnull
.AssertionError
- if the actual value is equal to or greater than the given one.
-
isLessThanOrEqualTo
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 isnull
.AssertionError
- if the actual value is greater than the given one.
-
isGreaterThan
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 isnull
.AssertionError
- if the actual value is equal to or less than the given one.
-
isGreaterThanOrEqualTo
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 isnull
.AssertionError
- if the actual value is less than the given one.
-
isBetween
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 interfaceComparableAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Specified by:
isBetween
in interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Overrides:
isBetween
in classAbstractComparableAssert<SELF extends AbstractIntegerAssert<SELF>,
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
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 interfaceComparableAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Specified by:
isStrictlyBetween
in interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Overrides:
isStrictlyBetween
in classAbstractComparableAssert<SELF extends AbstractIntegerAssert<SELF>,
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
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 isnull
.AssertionError
- if the actual value is not close to the given one.
-
isNotCloseTo
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 isnull
.AssertionError
- if the actual value is close to the given one.- Since:
- 2.6.0 / 3.6.0
- See Also:
-
isCloseTo
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
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 isnull
.AssertionError
- if the actual value is not close to the given one.
-
isNotCloseTo
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
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 isnull
.AssertionError
- if the actual value is close to the given one.- Since:
- 2.6.0 / 3.6.0
- See Also:
-
isCloseTo
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
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 isnull
.NullPointerException
- if the expected number isnull
.AssertionError
- if the actual value is not equal to the given one.
-
isNotCloseTo
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 interfaceNumberAssert<SELF extends AbstractIntegerAssert<SELF>,
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 isnull
.NullPointerException
- if the expected number isnull
.AssertionError
- if the actual value is close to the given one.- Since:
- 2.6.0 / 3.6.0
-
isCloseTo
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 isnull
.NullPointerException
- if the expected number isnull
.AssertionError
- if the actual value is not close enough to the given one.
-
isNotCloseTo
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 givenPercentage
isnull
.NullPointerException
- if the expected number isnull
.AssertionError
- if the actual value is close to the given one.- Since:
- 2.6.0 / 3.6.0
-
usingComparator
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 interfaceAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Overrides:
usingComparator
in classAbstractComparableAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Parameters:
customComparator
- the comparator to use for incoming assertion checks.- Returns:
this
assertion object.
-
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 interfaceAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Overrides:
usingDefaultComparator
in classAbstractComparableAssert<SELF extends AbstractIntegerAssert<SELF>,
Integer> - Returns:
this
assertion object.
-