org.fest.assertions
Class DoubleAssert

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

public class DoubleAssert
extends PrimitiveAssert
implements NumberAssert

Understands Assertion methods for Double. To create a new instance of this class use the method Assertions.assertThat(double).

Author:
Yvonne Wang, David DIDIER, Alex Ruiz

Nested Class Summary
static class DoubleAssert.Delta
          Deprecated. use top-level class Delta instead. This class will be removed in version 2.0.
 
Constructor Summary
protected DoubleAssert(double actual)
          Creates a new DoubleAssert.
 
Method Summary
 DoubleAssert as(Description description)
          Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
 DoubleAssert as(String description)
          Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
static DoubleAssert.Delta delta(double d)
          Deprecated. use method Delta.delta(double) instead. This method will be removed in version 2.0.
 DoubleAssert describedAs(Description description)
          Alias for as(Description), since "as" is a keyword in Groovy.
 DoubleAssert describedAs(String description)
          Alias for as(String), since "as" is a keyword in Groovy.
 DoubleAssert isEqualTo(double expected)
          Verifies that the actual double value is equal to the given one.
 DoubleAssert isEqualTo(double expected, Delta delta)
          Verifies that the actual double value is equal to the given one, within a positive delta.
 DoubleAssert isEqualTo(double expected, DoubleAssert.Delta delta)
          Deprecated. use method isEqualTo(double, org.fest.assertions.Delta) instead. This method will be removed in version 2.0.
 DoubleAssert isGreaterThan(double other)
          Verifies that the actual double value is greater than the given one.
 DoubleAssert isGreaterThanOrEqualTo(double other)
          Verifies that the actual double value is greater or equal to the given one.
 DoubleAssert isLessThan(double other)
          Verifies that the actual double value is less than the given one.
 DoubleAssert isLessThanOrEqualTo(double other)
          Verifies that the actual double value is less or equal to the given one.
 DoubleAssert isNaN()
          Verifies that the actual double value is equal to Double.NaN.
 DoubleAssert isNegative()
          Verifies that the actual double value is negative.
 DoubleAssert isNotEqualTo(double other)
          Verifies that the actual double value is not equal to the given one.
 DoubleAssert isPositive()
          Verifies that the actual double value is positive.
 DoubleAssert isZero()
          Verifies that the actual double value is equal to zero.
 DoubleAssert 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

DoubleAssert

protected DoubleAssert(double actual)
Creates a new DoubleAssert.

Parameters:
actual - the target to verify.
Method Detail

as

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

isNotEqualTo

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

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

isGreaterThan

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

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

isLessThan

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

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

isGreaterThanOrEqualTo

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

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

isLessThanOrEqualTo

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

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

isZero

public DoubleAssert isZero()
Verifies that the actual double value is equal to zero.

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

isPositive

public DoubleAssert isPositive()
Verifies that the actual double value is positive.

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

isNegative

public DoubleAssert isNegative()
Verifies that the actual double value is negative.

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

isNaN

public DoubleAssert isNaN()
Verifies that the actual double value is equal to Double.NaN.

Returns:
this assertion object.
Throws:
AssertionError - if the actual double value is not equal to NAN.

isEqualTo

@Deprecated
public DoubleAssert isEqualTo(double expected,
                                         DoubleAssert.Delta delta)
Deprecated. use method isEqualTo(double, org.fest.assertions.Delta) instead. This method will be removed in version 2.0.

Verifies that the actual double value is equal to the given one, within a positive delta.

Parameters:
expected - the value to compare the actual one to.
delta - the given delta.
Returns:
this assertion object.
Throws:
AssertionError - if the actual double value is not equal to the given one.

isEqualTo

public DoubleAssert isEqualTo(double expected,
                              Delta delta)
Verifies that the actual double value is equal to the given one, within a positive delta.

Parameters:
expected - the value to compare the actual one to.
delta - the given delta.
Returns:
this assertion object.
Throws:
AssertionError - if the actual double value is not equal to the given one.
Since:
1.1

delta

@Deprecated
public static DoubleAssert.Delta delta(double d)
Deprecated. use method Delta.delta(double) instead. This method will be removed in version 2.0.

Creates a new holder for a delta value to be used in isEqualTo(double, org.fest.assertions.DoubleAssert.Delta).

Parameters:
d - the delta value.
Returns:
a new delta value holder.

overridingErrorMessage

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