org.assertj.core.api

Class AbstractShortAssert<S extends AbstractShortAssert<S>>

java.lang.Object

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

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

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

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

Direct Known Subclasses:

ShortAssert

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

Base class for all implementations of assertions for Shorts.

Author:

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

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

Method Summary

Methods

Modifier and Type	Method and Description
S	isBetween(Short start, Short end) Verifies that the actual value is in [start, end] range (start included, end included).
S	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.
S	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.
S	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.
S	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.
S	isEqualTo(short expected) Verifies that the actual value is equal to the given one.
S	isGreaterThan(short other) Verifies that the actual value is greater than the given one.
S	isGreaterThanOrEqualTo(short other) Verifies that the actual value is greater than or equal to the given one.
S	isLessThan(short other) Verifies that the actual value is less than the given one.
S	isLessThanOrEqualTo(short 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(short 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(Short start, Short 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 Short> 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

extracting, hasFieldOrProperty, hasFieldOrPropertyWithValue, isEqualToComparingFieldByField, isEqualToComparingOnlyGivenFields, isEqualToIgnoringGivenFields, isEqualToIgnoringNullFields

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

as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, 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, overridingErrorMessage, withFailMessage, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractShortAssert

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

Method Detail

isEqualTo

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

Verifies that the actual value is equal to zero.

Example:

 int intZero = 0;
 long longZero = 0L;

 // assertions will pass
 assertThat(intZero).isZero();
 assertThat(longZero).isZero();

 int meaningOfLife = 42;
 double someOfPi = 3.142;

 // assertions will fail
 assertThat(meaningOfLife).isZero();
 assertThat(someOfPi).isZero();

Specified by:

isZero in interface NumberAssert<S extends AbstractShortAssert<S>,Short>

Returns:

this assertion object.

isNotZero

public S isNotZero()

Verifies that the actual value is not equal to zero.

Example:

 int meaningOfLife = 42;
 double someOfPi = 3.142;

 // assertions will pass
 assertThat(meaningOfLife).isNotZero();
 assertThat(someOfPi).isNotZero();

 int intZero = 0;
 long longZero = 0L;

 // assertions will fail
 assertThat(intZero).isNotZero();
 assertThat(longZero).isNotZero();

Specified by:

isNotZero in interface NumberAssert<S extends AbstractShortAssert<S>,Short>

Returns:

this assertion object.

isPositive

public S isPositive()

Verifies that the actual value is positive.

Example:

 int positive = 42;
 int zero = 0;
 int negative = -42;

 // assertions will pass
 assertThat(positive).isPositive();

 // assertions will fail
 assertThat(zero).isPositive();
 assertThat(negative).isPositive();

Specified by:

isPositive in interface NumberAssert<S extends AbstractShortAssert<S>,Short>

Returns:

this assertion object.

isNegative

public S isNegative()

Verifies that the actual value is negative.

Example:

 int positive = 42;
 int zero = 0;
 int negative = -42;

 // assertions will pass
 assertThat(negative).isNegative();

 // assertions will fail
 assertThat(zero).isNegative();
 assertThat(positive).isNegative();

Specified by:

isNegative in interface NumberAssert<S extends AbstractShortAssert<S>,Short>

Returns:

this assertion object.

isNotNegative

public S isNotNegative()

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

Example:

 int positive = 42;
 int zero = 0;
 int negative = -42;

 // assertions will pass
 assertThat(positive).isNotNegative();
 assertThat(zero).isNotNegative();

 // assertions will fail
 assertThat(negative).isNotNegative();

Specified by:

isNotNegative in interface NumberAssert<S extends AbstractShortAssert<S>,Short>

Returns:

this assertion object.

isNotPositive

public S isNotPositive()

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

Example:

 int positive = 42;
 int zero = 0;
 int negative = -42;

 // assertions will pass
 assertThat(negative).isNotPositive();
 assertThat(zero).isNotPositive();

 // assertions will fail
 assertThat(positive).isNotPositive();

Specified by:

isNotPositive in interface NumberAssert<S extends AbstractShortAssert<S>,Short>

Returns:

this assertion object.

isLessThan

public S 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 S 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 S 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 S 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 S isBetween(Short start,
          Short end)

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

Example:

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

Specified by:

isBetween in interface NumberAssert<S extends AbstractShortAssert<S>,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 S isStrictlyBetween(Short start,
                  Short end)

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

Example:

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

Specified by:

isStrictlyBetween in interface NumberAssert<S extends AbstractShortAssert<S>,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 S 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 equal to the given one.

isCloseTo

public S 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<S extends AbstractShortAssert<S>,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 equal to the given one.

isCloseTo

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

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(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 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 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<S extends AbstractShortAssert<S>,Short>

Overrides:

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

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 AbstractShortAssert<S>,Short>

Overrides:

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

Returns:

this assertion object.