org.fest.assertions
Class FloatAssert

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

All Implemented Interfaces:

NumberAssert

public class FloatAssert
extends PrimitiveAssert
implements NumberAssert

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

Author:

Yvonne Wang, Alex Ruiz

Nested Class Summary

static class

FloatAssert.Delta Deprecated. use top-level class Delta instead. This class will be removed in version 2.0.

Constructor Summary

protected

FloatAssert(float actual) Creates a new FloatAssert.

Method Summary

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

FloatAssert

protected FloatAssert(float actual)

Creates a new FloatAssert.

Parameters:

actual - the target to verify.

Method Detail

as

public FloatAssert 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 FloatAssert 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 FloatAssert 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 FloatAssert 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 FloatAssert isEqualTo(float expected)

Verifies that the actual float 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 float value is not equal to the given one.

isEqualTo

@Deprecated
public FloatAssert isEqualTo(float expected,
                                        FloatAssert.Delta delta)

Deprecated. use method isEqualTo(float, org.fest.assertions.Delta) instead. This method will be removed in version 2.0.

Verifies that the actual float 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 float value is not equal to the given one.

isEqualTo

public FloatAssert isEqualTo(float expected,
                             Delta delta)

Verifies that the actual float value is equal to tdelta.valuene, 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 float value is not equal to the given one.

Since:

1.2

isNotEqualTo

public FloatAssert isNotEqualTo(float other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isGreaterThan

public FloatAssert isGreaterThan(float other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isLessThan

public FloatAssert isLessThan(float other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isGreaterThanOrEqualTo

public FloatAssert isGreaterThanOrEqualTo(float other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isLessThanOrEqualTo

public FloatAssert isLessThanOrEqualTo(float other)

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

Parameters:

other - the given value.

Returns:

this assertion object.

Throws:

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

isNaN

public FloatAssert isNaN()

Verifies that the actual float value is equal to Float.NaN.

Returns:

this assertion object.

Throws:

AssertionError - if the actual float value is not equal to NaN.

isZero

public FloatAssert isZero()

Verifies that the actual float value is equal to zero.

Specified by:

isZero in interface NumberAssert

Returns:

this assertion object.

Throws:

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

isPositive

public FloatAssert isPositive()

Verifies that the actual float value is positive.

Specified by:

isPositive in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual float value is not positive.

isNegative

public FloatAssert isNegative()

Verifies that the actual float value is negative.

Specified by:

isNegative in interface NumberAssert

Returns:

this assertion object.

Throws:

AssertionError - if the actual float value is not negative.

delta

@Deprecated
public static FloatAssert.Delta delta(float 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(float, org.fest.assertions.FloatAssert.Delta).

Parameters:

d - the delta value.

Returns:

a new delta value holder.

overridingErrorMessage

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