org.fest.assertions
Class LongAssert

java.lang.Object
  org.fest.assertions.Assert
      org.fest.assertions.PrimitiveAssert
          org.fest.assertions.LongAssert

All Implemented Interfaces:

NumberAssert

public class LongAssert
extends PrimitiveAssert
implements NumberAssert

Understands assertion methods for longs. To create a new instance of this class use the method Assertions.assertThat(long).

Author:

Yvonne Wang, David DIDIER

Constructor Summary

protected

LongAssert(long actual) Creates a new LongAssert.

Method Summary

LongAssert	as(Description description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
LongAssert	as(String description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
LongAssert	describedAs(Description description) Alias for as(Description), since "as" is a keyword in Groovy.
LongAssert	describedAs(String description) Alias for as(String), since "as" is a keyword in Groovy.
LongAssert	isEqualTo(long expected) Verifies that the actual long value is equal to the given one.
LongAssert	isGreaterThan(long other) Verifies that the actual long value is greater than the given one.
LongAssert	isGreaterThanOrEqualTo(long other) Verifies that the actual long value is greater or equal to the given one.
LongAssert	isLessThan(long other) Verifies that the actual long value is less than the given one.
LongAssert	isLessThanOrEqualTo(long other) Verifies that the actual long value is less or equal to the given one.
LongAssert	isNegative() Verifies that the actual long value is negative.
LongAssert	isNotEqualTo(long other) Verifies that the actual long value is not equal to the given one.
LongAssert	isPositive() Verifies that the actual long value is positive.
LongAssert	isZero() Verifies that the actual long value is equal to zero.
LongAssert	overridingErrorMessage(String message) Replaces the default message displayed in case of a failure with the given one.

Methods inherited from class org.fest.assertions.Assert

customErrorMessage, description, description, description, equals, fail, fail, failIfCustomMessageIsSet, failIfCustomMessageIsSet, failure, formattedErrorMessage, hashCode, rawDescription, replaceDefaultErrorMessagesWith

Methods inherited from class java.lang.Object

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

Constructor Detail

LongAssert

protected LongAssert(long actual)

Creates a new LongAssert.

Parameters:

actual - the target to verify.

Method Detail

as

public LongAssert as(String description)

Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).as("Some value").isEqualTo(otherValue);
 

Specified by:

as in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public LongAssert describedAs(String description)

Alias for as(String), since "as" is a keyword in Groovy. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).describedAs("Some value").isEqualTo(otherValue);
 

Specified by:

describedAs in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

as

public LongAssert as(Description description)

Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).as(new BasicDescription("Some value")).isEqualTo(otherValue);
 

Specified by:

as in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public LongAssert describedAs(Description description)

Alias for as(Description), since "as" is a keyword in Groovy. This method should be called before any assertion method, otherwise any assertion failure will not show the provided description.

For example:

 assertThat(value).describedAs(new BasicDescription("Some value")).isEqualTo(otherValue);
 

Specified by:

describedAs in class PrimitiveAssert

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

isEqualTo

public LongAssert isEqualTo(long expected)

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

Parameters:

expected - the value to compare the actual one to.

Returns:

this assertion object.

Throws:

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

isNotEqualTo

public LongAssert isNotEqualTo(long other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isGreaterThan

public LongAssert isGreaterThan(long other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

AssertionError - if the actual long value is not greater than the given one.

isLessThan

public LongAssert isLessThan(long other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

AssertionError - if the actual long value is not less than the given one.

isGreaterThanOrEqualTo

public LongAssert isGreaterThanOrEqualTo(long other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

AssertionError - if the actual long value is not greater than or equal to the given one.

isLessThanOrEqualTo

public LongAssert isLessThanOrEqualTo(long other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

AssertionError - if the actual long value is not less than or equal to the given one.

isZero

public LongAssert isZero()

Verifies that the actual long value is equal to zero.

Specified by:

isZero in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual long value is not equal to zero.

isPositive

public LongAssert isPositive()

Verifies that the actual long value is positive.

Specified by:

isPositive in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual long value is not positive.

isNegative

public LongAssert isNegative()

Verifies that the actual long value is negative.

Specified by:

isNegative in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual long value is not negative.

overridingErrorMessage

public LongAssert overridingErrorMessage(String message)

Replaces the default message displayed in case of a failure with the given one.

For example, the following assertion:

 assertThat("Hello").isEqualTo("Bye");
 

will fail with the default message "expected:<'[Bye]'> but was:<'[Hello]'>."

We can replace this message with our own:

 assertThat("Hello").overridingErrorMessage("'Hello' should be equal to 'Bye'").isEqualTo("Bye");
 

in this case, the assertion will fail showing the message "'Hello' should be equal to 'Bye'".

Specified by:

overridingErrorMessage in class PrimitiveAssert

Parameters:

message - the given error message, which will replace the default one.

Returns:

this assertion.