org.assertj.core.api

Class AbstractLongAssert<S extends AbstractLongAssert<S>>

java.lang.Object

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

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

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

org.assertj.core.api.AbstractLongAssert<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,Long>, ComparableAssert<S,Long>, Descriptable<S>, ExtensionPoints<S,Long>, NumberAssert<S,Long>

Direct Known Subclasses:

LongAssert

public abstract class AbstractLongAssert<S extends AbstractLongAssert<S>>
extends AbstractComparableAssert<S,Long>
implements NumberAssert<S,Long>

Base class for all implementations of assertions for Longs.

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	AbstractLongAssert(Long actual, Class<?> selfType)

Method Summary

Modifier and Type	Method and Description
S	isBetween(Long start, Long end) Verifies that the actual value is in [start, end] range (start included, end included).
S	isCloseTo(long expected, Offset<Long> offset) Verifies that the actual long is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
S	isCloseTo(Long expected, Offset<Long> offset) Verifies that the actual long is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
S	isCloseTo(long 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(Long 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(long expected) Verifies that the actual value is equal to the given one.
S	isGreaterThan(long other) Verifies that the actual value is greater than the given one.
S	isGreaterThanOrEqualTo(long other) Verifies that the actual value is greater than or equal to the given one.
S	isLessThan(long other) Verifies that the actual value is less than the given one.
S	isLessThanOrEqualTo(long 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	isNotEqualTo(long 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(Long start, Long 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 Long> 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

isEqualToComparingFieldByField, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLongAssert

protected AbstractLongAssert(Long actual,
                             Class<?> selfType)

Method Detail

isEqualTo

public S isEqualTo(long 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 S isNotEqualTo(long 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 S isZero()

Verifies that the actual value is equal to zero.

Specified by:

isZero in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Returns:

this assertion object.

isNotZero

public S isNotZero()

Verifies that the actual value is not equal to zero.

Specified by:

isNotZero in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Returns:

this assertion object.

isPositive

public S isPositive()

Verifies that the actual value is positive.

Specified by:

isPositive in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Returns:

this assertion object.

isNegative

public S isNegative()

Verifies that the actual value is negative.

Specified by:

isNegative in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Returns:

this assertion object.

isNotNegative

public S isNotNegative()

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

Specified by:

isNotNegative in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Returns:

this assertion object.

isNotPositive

public S isNotPositive()

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

Specified by:

isNotPositive in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Returns:

this assertion object.

isLessThan

public S isLessThan(long 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 S isLessThanOrEqualTo(long 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 S isGreaterThan(long 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 S isGreaterThanOrEqualTo(long 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.

isBetween

public S isBetween(Long start,
                   Long end)

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

 // these assertions succeed ... 
 assertThat(12).isBetween(10, 14);
 assertThat(12).isBetween(12, 14);
 assertThat(12).isBetween(10, 12);
 
 // ... but these one fails
 assertThat(12).isBetween(14, 16);
 

Specified by:

isBetween in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

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(Long start,
                           Long end)

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

 // this assertion succeeds ... 
 assertThat(12).isBetween(10, 14);
 
 // ... but these one fails
 assertThat(12).isBetween(12, 14);
 assertThat(12).isBetween(10, 12);
 assertThat(12).isBetween(16, 18);
 

Specified by:

isStrictlyBetween in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

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(long expected,
                   Offset<Long> offset)

Verifies that the actual long 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(5l).isCloseTo(7l, within(3l));

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

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

Parameters:

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

isCloseTo

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

Verifies that the actual long 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(5l).isCloseTo(Long.valueOf(7l), within(3l));

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

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

Specified by:

isCloseTo in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Parameters:

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

isCloseTo

public S isCloseTo(Long 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 long:

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

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

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

Specified by:

isCloseTo in interface NumberAssert<S extends AbstractLongAssert<S>,Long>

Parameters:

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

percentage - the given positive percentage between 0 and 100.

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.

isCloseTo

public S isCloseTo(long 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 long:

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

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

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

Parameters:

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

percentage - the given positive percentage between 0 and 100.

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.

usingComparator

public S usingComparator(Comparator<? super Long> 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 AbstractLongAssert<S>,Long>

Overrides:

usingComparator in class AbstractComparableAssert<S extends AbstractLongAssert<S>,Long>

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 AbstractLongAssert<S>,Long>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<S extends AbstractLongAssert<S>,Long>

Returns:

this assertion object.