org.fest.assertions
Class FloatArrayAssert

java.lang.Object
  org.fest.assertions.Assert
      org.fest.assertions.GenericAssert<T>
          org.fest.assertions.GroupAssert<T>
              org.fest.assertions.ArrayAssert<float[]>
                  org.fest.assertions.FloatArrayAssert

public class FloatArrayAssert
extends ArrayAssert<float[]>

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

Author:

Yvonne Wang, Alex Ruiz

Field Summary

Fields inherited from class org.fest.assertions.GenericAssert

actual

Constructor Summary

protected

FloatArrayAssert(float... actual) Creates a new FloatArrayAssert.

Method Summary

FloatArrayAssert	as(Description description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
FloatArrayAssert	as(String description) Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
FloatArrayAssert	contains(float... values) Verifies that the actual float array contains the given values.
FloatArrayAssert	containsOnly(float... values) Verifies that the actual float array contains the given values only.
FloatArrayAssert	describedAs(Description description) Alias for GenericAssert.as(Description), since "as" is a keyword in Groovy.
FloatArrayAssert	describedAs(String description) Alias for GenericAssert.as(String), since "as" is a keyword in Groovy.
FloatArrayAssert	doesNotSatisfy(Condition<float[]> condition) Verifies that the actual float array does not satisfy the given condition.
FloatArrayAssert	excludes(float... values) Verifies that the actual float array does not contain the given values.
FloatArrayAssert	hasSize(int expected) Verifies that the number of elements in the actual float array is equal to the given one.
FloatArrayAssert	is(Condition<float[]> condition) Alias for satisfies(Condition).
FloatArrayAssert	isEqualTo(float[] expected) Verifies that the actual float array is equal to the given array.
FloatArrayAssert	isNot(Condition<float[]> condition) Alias for doesNotSatisfy(Condition).
FloatArrayAssert	isNotEmpty() Verifies that the actual float array contains at least on element.
FloatArrayAssert	isNotEqualTo(float[] array) Verifies that the actual float array is not equal to the given array.
FloatArrayAssert	isNotNull() Verifies that the actual float array is not null.
FloatArrayAssert	isNotSameAs(float[] expected) Verifies that the actual float array is not the same as the given array.
FloatArrayAssert	isSameAs(float[] expected) Verifies that the actual float array is the same as the given array.
FloatArrayAssert	overridingErrorMessage(String message) Replaces the default message displayed in case of a failure with the given one.
FloatArrayAssert	satisfies(Condition<float[]> condition) Verifies that the actual float array satisfies the given condition.

Methods inherited from class org.fest.assertions.ArrayAssert

actualGroupSize, actualInBrackets, assertContains, assertContainsOnly, assertExcludes, assertThatActualHasSize, assertThatActualIsNotEmpty, assertThatActualIsNotNull, isEmpty, isNullOrEmpty

Methods inherited from class org.fest.assertions.GenericAssert

assertDoesNotSatisfy, assertEqualTo, assertIs, assertIsNot, assertNotEqualTo, assertNotNull, assertNotSameAs, assertSameAs, assertSatisfies, isNull

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

FloatArrayAssert

protected FloatArrayAssert(float... actual)

Creates a new FloatArrayAssert.

Parameters:

actual - the target to verify.

Method Detail

as

public FloatArrayAssert 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(val).as("name").isEqualTo("Frodo");
 

Specified by:

as in class GenericAssert<float[]>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public FloatArrayAssert describedAs(String description)

Alias for GenericAssert.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(val).describedAs("name").isEqualTo("Frodo");
 

Specified by:

describedAs in class GenericAssert<float[]>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

as

public FloatArrayAssert 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(val).as(new BasicDescription("name")).isEqualTo("Frodo");
 

Specified by:

as in class GenericAssert<float[]>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

describedAs

public FloatArrayAssert describedAs(Description description)

Alias for GenericAssert.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(val).describedAs(new BasicDescription("name")).isEqualTo("Frodo");
 

Specified by:

describedAs in class GenericAssert<float[]>

Parameters:

description - the description of the actual value.

Returns:

this assertion object.

contains

public FloatArrayAssert contains(float... values)

Verifies that the actual float array contains the given values.

Parameters:

values - the values to look for.

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is null.

NullPointerException - if the given float array is null.

AssertionError - if the actual float array does not contain the given values.

containsOnly

public FloatArrayAssert containsOnly(float... values)

Verifies that the actual float array contains the given values only.

Parameters:

values - the values to look for.

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is null.

NullPointerException - if the given float array is null.

AssertionError - if the actual float array does not contain the given objects, or if the actual float array contains elements other than the ones specified.

excludes

public FloatArrayAssert excludes(float... values)

Verifies that the actual float array does not contain the given values.

Parameters:

values - the values the array should exclude.

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is null.

NullPointerException - if the given float array is null.

AssertionError - if the actual Object array contains any of the given values.

satisfies

public FloatArrayAssert satisfies(Condition<float[]> condition)

Verifies that the actual float array satisfies the given condition.

Specified by:

satisfies in class GenericAssert<float[]>

Parameters:

condition - the given condition.

Returns:

this assertion object.

Throws:

NullPointerException - if the given condition is null.

AssertionError - if the actual float array does not satisfy the given condition.

See Also:

is(Condition)

doesNotSatisfy

public FloatArrayAssert doesNotSatisfy(Condition<float[]> condition)

Verifies that the actual float array does not satisfy the given condition.

Specified by:

doesNotSatisfy in class GenericAssert<float[]>

Parameters:

condition - the given condition.

Returns:

this assertion object.

Throws:

NullPointerException - if the given condition is null.

AssertionError - if the actual float array satisfies the given condition.

See Also:

isNot(Condition)

is

public FloatArrayAssert is(Condition<float[]> condition)

Alias for satisfies(Condition).

Specified by:

is in class GenericAssert<float[]>

Parameters:

condition - the given condition.

Returns:

this assertion object.

Throws:

NullPointerException - if the given condition is null.

AssertionError - if the actual float array does not satisfy the given condition.

Since:

1.2

isNot

public FloatArrayAssert isNot(Condition<float[]> condition)

Alias for doesNotSatisfy(Condition).

Specified by:

isNot in class GenericAssert<float[]>

Parameters:

condition - the given condition.

Returns:

this assertion object.

Throws:

NullPointerException - if the given condition is null.

AssertionError - if the actual float array satisfies the given condition.

Since:

1.2

isNotNull

public FloatArrayAssert isNotNull()

Verifies that the actual float array is not null.

Specified by:

isNotNull in class GenericAssert<float[]>

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is null.

isNotEmpty

public FloatArrayAssert isNotEmpty()

Verifies that the actual float array contains at least on element.

Specified by:

isNotEmpty in class GroupAssert<float[]>

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is null.

AssertionError - if the actual float array is empty.

isEqualTo

public FloatArrayAssert isEqualTo(float[] expected)

Verifies that the actual float array is equal to the given array. Array equality is checked by Arrays.equals(float[], float[]).

Specified by:

isEqualTo in class GenericAssert<float[]>

Parameters:

expected - the given array to compare the actual array to.

Returns:

this assertion object.

Throws:

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

isNotEqualTo

public FloatArrayAssert isNotEqualTo(float[] array)

Verifies that the actual float array is not equal to the given array. Array equality is checked by Arrays.equals(float[], float[]).

Specified by:

isNotEqualTo in class GenericAssert<float[]>

Parameters:

array - the given array to compare the actual array to.

Returns:

this assertion object.

Throws:

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

hasSize

public FloatArrayAssert hasSize(int expected)

Verifies that the number of elements in the actual float array is equal to the given one.

Specified by:

hasSize in class GroupAssert<float[]>

Parameters:

expected - the expected number of elements in the actual float array.

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is null.

AssertionError - if the number of elements in the actual float array is not equal to the given one.

isSameAs

public FloatArrayAssert isSameAs(float[] expected)

Verifies that the actual float array is the same as the given array.

Specified by:

isSameAs in class GenericAssert<float[]>

Parameters:

expected - the given array to compare the actual array to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is not the same as the given one.

isNotSameAs

public FloatArrayAssert isNotSameAs(float[] expected)

Verifies that the actual float array is not the same as the given array.

Specified by:

isNotSameAs in class GenericAssert<float[]>

Parameters:

expected - the given array to compare the actual array to.

Returns:

this assertion object.

Throws:

AssertionError - if the actual float array is the same as the given one.

overridingErrorMessage

public FloatArrayAssert 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 GenericAssert<float[]>

Parameters:

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

Returns:

this assertion.