org.fest.assertions
Class IntAssert

java.lang.Object
  extended by org.fest.assertions.Assert
      extended by org.fest.assertions.PrimitiveAssert
          extended by org.fest.assertions.IntAssert
All Implemented Interfaces:
NumberAssert

public class IntAssert
extends PrimitiveAssert
implements NumberAssert

Understands assert method for ints. To create a new instance of this class use the method Assertions.assertThat(int).

Author:
Yvonne Wang, David DIDIER

Constructor Summary
protected IntAssert(int actual)
          Creates a new IntAssert.
 
Method Summary
 IntAssert as(Description description)
          Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
 IntAssert as(String description)
          Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
 IntAssert describedAs(Description description)
          Alias for as(Description), since "as" is a keyword in Groovy.
 IntAssert describedAs(String description)
          Alias for as(String), since "as" is a keyword in Groovy.
 IntAssert isEqualTo(int expected)
          Verifies that the actual int value is equal to the given one.
 IntAssert isGreaterThan(int other)
          Verifies that the actual int value is greater than the given one.
 IntAssert isGreaterThanOrEqualTo(int other)
          Verifies that the actual int value is greater or equal to the given one.
 IntAssert isLessThan(int other)
          Verifies that the actual int value is less than the given one.
 IntAssert isLessThanOrEqualTo(int other)
          Verifies that the actual int value is less or equal to the given one.
 IntAssert isNegative()
          Verifies that the actual int value is negative.
 IntAssert isNotEqualTo(int other)
          Verifies that the actual int value is not equal to the given one.
 IntAssert isPositive()
          Verifies that the actual int value is positive.
 IntAssert isZero()
          Verifies that the actual int value is equal to zero.
 IntAssert 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

IntAssert

protected IntAssert(int actual)
Creates a new IntAssert.

Parameters:
actual - the target to verify.
Method Detail

as

public IntAssert 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 IntAssert 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 IntAssert 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 IntAssert 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 IntAssert isEqualTo(int expected)
Verifies that the actual int 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 int value is not equal to the given one.

isNotEqualTo

public IntAssert isNotEqualTo(int other)
Verifies that the actual int value is not equal to the given one.

Parameters:
other - the given value.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is equal to the given one.

isGreaterThan

public IntAssert isGreaterThan(int other)
Verifies that the actual int value is greater than the given one.

Parameters:
other - the given value.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is not greater than the given one.

isLessThan

public IntAssert isLessThan(int other)
Verifies that the actual int value is less than the given one.

Parameters:
other - the given value.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is not less than the given one.

isGreaterThanOrEqualTo

public IntAssert isGreaterThanOrEqualTo(int other)
Verifies that the actual int value is greater or equal to the given one.

Parameters:
other - the given value.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is not greater than or equal to the given one.

isLessThanOrEqualTo

public IntAssert isLessThanOrEqualTo(int other)
Verifies that the actual int value is less or equal to the given one.

Parameters:
other - the given value.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is not less than or equal to the given one.

isZero

public IntAssert isZero()
Verifies that the actual int value is equal to zero.

Specified by:
isZero in interface NumberAssert
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is not equal to zero.

isPositive

public IntAssert isPositive()
Verifies that the actual int value is positive.

Specified by:
isPositive in interface NumberAssert
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is not positive.

isNegative

public IntAssert isNegative()
Verifies that the actual int value is negative.

Specified by:
isNegative in interface NumberAssert
Returns:
this assertion object.
Throws:
AssertionError - if the actual int value is not negative.

overridingErrorMessage

public IntAssert 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.


Copyright © 2007-2010 FEST (Fixtures for Easy Software Testing). All Rights Reserved.