org.fest.assertions
Class ShortAssert

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

public class ShortAssert
extends PrimitiveAssert
implements NumberAssert

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

Author:
Yvonne Wang, David DIDIER

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

ShortAssert

protected ShortAssert(short actual)
Creates a new ShortAssert.

Parameters:
actual - the target to verify.
Method Detail

as

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

isNotEqualTo

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

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

isGreaterThan

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

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

isLessThan

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

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

isGreaterThanOrEqualTo

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

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

isLessThanOrEqualTo

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

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

isZero

public ShortAssert isZero()
Verifies that the actual short value is equal to zero.

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

isPositive

public ShortAssert isPositive()
Verifies that the actual short value is positive.

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

isNegative

public ShortAssert isNegative()
Verifies that the actual short value is negative.

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

overridingErrorMessage

public ShortAssert 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-2011 FEST (Fixtures for Easy Software Testing). All Rights Reserved.