org.fest.assertions
Class IntArrayAssert

java.lang.Object
  extended by org.fest.assertions.Assert
      extended by org.fest.assertions.GenericAssert<T>
          extended by org.fest.assertions.GroupAssert<T>
              extended by org.fest.assertions.ArrayAssert<int[]>
                  extended by org.fest.assertions.IntArrayAssert

public class IntArrayAssert
extends ArrayAssert<int[]>

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

Author:
Yvonne Wang, Alex Ruiz

Field Summary
 
Fields inherited from class org.fest.assertions.GenericAssert
actual
 
Constructor Summary
protected IntArrayAssert(int... actual)
          Creates a new IntArrayAssert.
 
Method Summary
 IntArrayAssert as(Description description)
          Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
 IntArrayAssert as(String description)
          Sets the description of the actual value, to be used in as message of any AssertionError thrown when an assertion fails.
 IntArrayAssert contains(int... values)
          Verifies that the actual int array contains the given values.
 IntArrayAssert containsOnly(int... values)
          Verifies that the actual int array contains the given values only.
 IntArrayAssert describedAs(Description description)
          Alias for GenericAssert.as(Description), since "as" is a keyword in Groovy.
 IntArrayAssert describedAs(String description)
          Alias for GenericAssert.as(String), since "as" is a keyword in Groovy.
 IntArrayAssert doesNotSatisfy(Condition<int[]> condition)
          Verifies that the actual int array does not satisfy the given condition.
 IntArrayAssert excludes(int... values)
          Verifies that the actual int array does not contain the given values.
 IntArrayAssert hasSize(int expected)
          Verifies that the number of elements in the actual int array is equal to the given one.
 IntArrayAssert is(Condition<int[]> condition)
          Alias for satisfies(Condition).
 IntArrayAssert isEqualTo(int[] expected)
          Verifies that the actual int array is equal to the given array.
 IntArrayAssert isNot(Condition<int[]> condition)
          Alias for doesNotSatisfy(Condition).
 IntArrayAssert isNotEmpty()
          Verifies that the actual int array contains at least on element.
 IntArrayAssert isNotEqualTo(int[] array)
          Verifies that the actual int array is not equal to the given array.
 IntArrayAssert isNotNull()
          Verifies that the actual int array is not null.
 IntArrayAssert isNotSameAs(int[] expected)
          Verifies that the actual int array is not the same as the given array.
 IntArrayAssert isSameAs(int[] expected)
          Verifies that the actual int array is the same as the given array.
 IntArrayAssert overridingErrorMessage(String message)
          Replaces the default message displayed in case of a failure with the given one.
 IntArrayAssert satisfies(Condition<int[]> condition)
          Verifies that the actual int 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

IntArrayAssert

protected IntArrayAssert(int... actual)
Creates a new IntArrayAssert.

Parameters:
actual - the target to verify.
Method Detail

as

public IntArrayAssert 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<int[]>
Parameters:
description - the description of the actual value.
Returns:
this assertion object.

describedAs

public IntArrayAssert 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<int[]>
Parameters:
description - the description of the actual value.
Returns:
this assertion object.

as

public IntArrayAssert 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<int[]>
Parameters:
description - the description of the actual value.
Returns:
this assertion object.

describedAs

public IntArrayAssert 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<int[]>
Parameters:
description - the description of the actual value.
Returns:
this assertion object.

contains

public IntArrayAssert contains(int... values)
Verifies that the actual int array contains the given values.

Parameters:
values - the values to look for.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is null.
NullPointerException - if the given int array is null.
AssertionError - if the actual int array does not contain the given values.

containsOnly

public IntArrayAssert containsOnly(int... values)
Verifies that the actual int array contains the given values only.

Parameters:
values - the values to look for.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is null.
NullPointerException - if the given int array is null.
AssertionError - if the actual int array does not contain the given objects, or if the actual int array contains elements other than the ones specified.

excludes

public IntArrayAssert excludes(int... values)
Verifies that the actual int array does not contain the given values.

Parameters:
values - the values the array should exclude.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is null.
NullPointerException - if the given int array is null.
AssertionError - if the actual int array contains any of the given values.

satisfies

public IntArrayAssert satisfies(Condition<int[]> condition)
Verifies that the actual int array satisfies the given condition.

Specified by:
satisfies in class GenericAssert<int[]>
Parameters:
condition - the given condition.
Returns:
this assertion object.
Throws:
NullPointerException - if the given condition is null.
AssertionError - if the actual int array does not satisfy the given condition.
See Also:
is(Condition)

doesNotSatisfy

public IntArrayAssert doesNotSatisfy(Condition<int[]> condition)
Verifies that the actual int array does not satisfy the given condition.

Specified by:
doesNotSatisfy in class GenericAssert<int[]>
Parameters:
condition - the given condition.
Returns:
this assertion object.
Throws:
NullPointerException - if the given condition is null.
AssertionError - if the actual int array satisfies the given condition.
See Also:
isNot(Condition)

is

public IntArrayAssert is(Condition<int[]> condition)
Alias for satisfies(Condition).

Specified by:
is in class GenericAssert<int[]>
Parameters:
condition - the given condition.
Returns:
this assertion object.
Throws:
NullPointerException - if the given condition is null.
AssertionError - if the actual int array does not satisfy the given condition.
Since:
1.2

isNot

public IntArrayAssert isNot(Condition<int[]> condition)
Alias for doesNotSatisfy(Condition).

Specified by:
isNot in class GenericAssert<int[]>
Parameters:
condition - the given condition.
Returns:
this assertion object.
Throws:
NullPointerException - if the given condition is null.
AssertionError - if the actual int array satisfies the given condition.
Since:
1.2

isNotNull

public IntArrayAssert isNotNull()
Verifies that the actual int array is not null.

Specified by:
isNotNull in class GenericAssert<int[]>
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is null.

isNotEmpty

public IntArrayAssert isNotEmpty()
Verifies that the actual int array contains at least on element.

Specified by:
isNotEmpty in class GroupAssert<int[]>
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is null.
AssertionError - if the actual int array is empty.

isEqualTo

public IntArrayAssert isEqualTo(int[] expected)
Verifies that the actual int array is equal to the given array. Array equality is checked by Arrays.equals(int[], int[]).

Specified by:
isEqualTo in class GenericAssert<int[]>
Parameters:
expected - the given array to compare the actual array to.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is not equal to the given one.

isNotEqualTo

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

Specified by:
isNotEqualTo in class GenericAssert<int[]>
Parameters:
array - the given array to compare the actual array to.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is equal to the given one.

hasSize

public IntArrayAssert hasSize(int expected)
Verifies that the number of elements in the actual int array is equal to the given one.

Specified by:
hasSize in class GroupAssert<int[]>
Parameters:
expected - the expected number of elements in the actual int array.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is null.
AssertionError - if the number of elements in the actual int array is not equal to the given one.

isSameAs

public IntArrayAssert isSameAs(int[] expected)
Verifies that the actual int array is the same as the given array.

Specified by:
isSameAs in class GenericAssert<int[]>
Parameters:
expected - the given array to compare the actual array to.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is not the same as the given one.

isNotSameAs

public IntArrayAssert isNotSameAs(int[] expected)
Verifies that the actual int array is not the same as the given array.

Specified by:
isNotSameAs in class GenericAssert<int[]>
Parameters:
expected - the given array to compare the actual array to.
Returns:
this assertion object.
Throws:
AssertionError - if the actual int array is the same as the given one.

overridingErrorMessage

public IntArrayAssert 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<int[]>
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.