Package org.assertj.core.api

Class AbstractShortAssert<SELF extends AbstractShortAssert<SELF>>

java.lang.Object

org.assertj.core.api.AbstractAssert<SELF,ACTUAL>

org.assertj.core.api.AbstractObjectAssert<SELF,ACTUAL>

org.assertj.core.api.AbstractComparableAssert<SELF,Short>

org.assertj.core.api.AbstractShortAssert<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,ACTUAL>, ComparableAssert<SELF,Short>, Descriptable<SELF>, ExtensionPoints<SELF,ACTUAL>, NumberAssert<SELF,Short>

Direct Known Subclasses:

ShortAssert

public abstract class AbstractShortAssert<SELF extends AbstractShortAssert<SELF>>
extends AbstractComparableAssert<SELF,Short>
implements NumberAssert<SELF,Short>

Base class for all implementations of assertions for Shorts.

Author:

Drummond Dawson, Yvonne Wang, David DIDIER, Ansgar Konermann, Alex Ruiz, Mikhail Mazursky, Nicolas François

Field Summary

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

actual, info, myself

Constructor Summary

Constructors

Constructor	Description
AbstractShortAssert(Short actual, Class<?> selfType)

Method Summary

Modifier and Type	Method	Description
SELF	isBetween(Short start, Short end)	Verifies that the actual value is in [start, end] range (start included, end included).
SELF	isCloseTo(short expected, Offset<Short> offset)	Verifies that the actual short is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
SELF	isCloseTo(short 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.
SELF	isCloseTo(Short expected, Offset<Short> offset)	Verifies that the actual short is close to the given one within the given offset. If difference is equal to offset value, assertion is considered valid.
SELF	isCloseTo(Short 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.
SELF	isEqualTo(short expected)	Verifies that the actual value is equal to the given one.
SELF	isGreaterThan(short other)	Verifies that the actual value is greater than the given one.
SELF	isGreaterThanOrEqualTo(short other)	Verifies that the actual value is greater than or equal to the given one.
SELF	isLessThan(short other)	Verifies that the actual value is less than the given one.
SELF	isLessThanOrEqualTo(short other)	Verifies that the actual value is less than or equal to the given one.
SELF	isNegative()	Verifies that the actual value is negative.
SELF	isNotCloseTo(short expected, Offset<Short> offset)	Verifies that the actual short 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.
SELF	isNotCloseTo(short expected, Percentage percentage)	Verifies that the actual number is not close to the given one within the given percentage. If difference is equal to the percentage value, the assertion fails.
SELF	isNotCloseTo(Short expected, Offset<Short> offset)	Verifies that the actual short 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.
SELF	isNotCloseTo(Short expected, Percentage percentage)	Verifies that the actual number is not close to the given one within the given percentage. If difference is equal to the percentage value, the assertion fails.
SELF	isNotEqualTo(short other)	Verifies that the actual value is not equal to the given one.
SELF	isNotNegative()	Verifies that the actual value is non negative (positive or equal zero).
SELF	isNotPositive()	Verifies that the actual value is non positive (negative or equal zero).
SELF	isNotZero()	Verifies that the actual value is not equal to zero.
SELF	isOne()	Verifies that the actual value is equal to one.
SELF	isPositive()	Verifies that the actual value is positive.
SELF	isStrictlyBetween(Short start, Short end)	Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).
SELF	isZero()	Verifies that the actual value is equal to zero.
SELF	usingComparator(Comparator<? super Short> customComparator)	Use given custom comparator instead of relying on actual type A equals method for incoming assertion checks.
SELF	usingDefaultComparator()	Revert to standard comparison for incoming assertion checks.

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 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 java.lang.Object

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

Constructor Detail

AbstractShortAssert

public AbstractShortAssert(Short actual,
                           Class<?> selfType)

Method Detail

isEqualTo

public SELF isEqualTo(short expected)

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

Example:

 // assertion will pass:
 assertThat(Short.valueOf("1")).isEqualTo((short) 1);
 
 // assertion will fail:
 assertThat(Short.valueOf("-1")).isEqualTo((short) 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 SELF isNotEqualTo(short other)

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

Example:

 // assertion will pass:
 assertThat(Short.valueOf(("-1")).isNotEqualTo((short) 1);
 
 // assertion will fail:
 assertThat(Short.valueOf("1")).isNotEqualTo((short) 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 SELF 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<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.

isNotZero

public SELF 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<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.

isOne

public SELF 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 interface NumberAssert<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.

isPositive

public SELF 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<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.

isNegative

public SELF 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<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.

isNotNegative

public SELF 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<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.

isNotPositive

public SELF 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<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.

isLessThan

public SELF isLessThan(short other)

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

Example:

 // assertion will pass:
 assertThat(Short.valueOf("1")).isLessThan((short) 2);
 
 // assertion will fail:
 assertThat(Short.valueOf("1")).isLessThan((short) 0);
 assertThat(Short.valueOf("1")).isLessThan((short) 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 SELF isLessThanOrEqualTo(short other)

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

Example:

 // assertion will pass:
 assertThat(Short.valueOf("1")).isLessThanOrEqualTo((short) 1);
 
 // assertion will fail:
 assertThat(Short.valueOf("1")).isLessThanOrEqualTo((short) 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 greater than the given one.

isGreaterThan

public SELF isGreaterThan(short other)

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

Example:

 // assertion will pass:
 assertThat(Short.valueOf("1")).isGreaterThan((short) 0);
 
 // assertions will fail:
 assertThat(Short.valueOf("0")).isGreaterThan((short) 1);
 assertThat(Short.valueOf("0")).isGreaterThan((short) 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 equal to or less than the given one.

isGreaterThanOrEqualTo

public SELF isGreaterThanOrEqualTo(short other)

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

Example:

 // assertion will pass:
 assertThat(Short.valueOf("1")).isGreaterThanOrEqualTo((short) 1);
 
 // assertion will fail:
 assertThat(Short.valueOf("0")).isGreaterThanOrEqualTo((short) 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 SELF isBetween(Short start,
                      Short 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<SELF extends AbstractShortAssert<SELF>,Short>

Specified by:

isBetween in interface NumberAssert<SELF extends AbstractShortAssert<SELF>,Short>

Overrides:

isBetween in class AbstractComparableAssert<SELF extends AbstractShortAssert<SELF>,Short>

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 SELF isStrictlyBetween(Short start,
                              Short 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<SELF extends AbstractShortAssert<SELF>,Short>

Specified by:

isStrictlyBetween in interface NumberAssert<SELF extends AbstractShortAssert<SELF>,Short>

Overrides:

isStrictlyBetween in class AbstractComparableAssert<SELF extends AbstractShortAssert<SELF>,Short>

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 SELF isCloseTo(short expected,
                      Offset<Short> offset)

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

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

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

Parameters:

expected - the given short 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 SELF isNotCloseTo(short expected,
                         Offset<Short> offset)

Verifies that the actual short 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((short)5).isNotCloseTo((short)7, byLessThan((short)1));

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

Parameters:

expected - the given short 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(Short)

isCloseTo

public SELF isCloseTo(Short expected,
                      Offset<Short> offset)

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

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

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

Specified by:

isCloseTo in interface NumberAssert<SELF extends AbstractShortAssert<SELF>,Short>

Parameters:

expected - the given short 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 SELF isNotCloseTo(Short expected,
                         Offset<Short> offset)

Verifies that the actual short 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((short)5).isNotCloseTo(Short.valueOf(7), byLessThan((short)1));

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

Specified by:

isNotCloseTo in interface NumberAssert<SELF extends AbstractShortAssert<SELF>,Short>

Parameters:

expected - the given short 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(Short)

isCloseTo

public SELF isCloseTo(Short 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 short:

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

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

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

Specified by:

isCloseTo in interface NumberAssert<SELF extends AbstractShortAssert<SELF>,Short>

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

isNotCloseTo

public SELF isNotCloseTo(Short expected,
                         Percentage percentage)

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

Example with short:

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

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

Specified by:

isNotCloseTo in interface NumberAssert<SELF extends AbstractShortAssert<SELF>,Short>

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 SELF isCloseTo(short 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 short:

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

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

 // assertion will fail
 assertThat((short)11).isCloseTo((short)10, withinPercentage((short)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 close to the given one.

isNotCloseTo

public SELF isNotCloseTo(short expected,
                         Percentage percentage)

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

Example with short:

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

 // assertions will fail
 assertThat((short)11).isNotCloseTo((short)10, withinPercentage((short)10));
 assertThat((short)11).isNotCloseTo((short)10, withinPercentage((short)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 SELF usingComparator(Comparator<? super Short> 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<SELF extends AbstractObjectAssert<SELF,ACTUAL>,ACTUAL>

Overrides:

usingComparator in class AbstractComparableAssert<SELF extends AbstractShortAssert<SELF>,Short>

Parameters:

customComparator - the comparator to use for incoming assertion checks.

Returns:

this assertion object.

usingDefaultComparator

public SELF 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<SELF extends AbstractObjectAssert<SELF,ACTUAL>,ACTUAL>

Overrides:

usingDefaultComparator in class AbstractComparableAssert<SELF extends AbstractShortAssert<SELF>,Short>

Returns:

this assertion object.