org.fest.assertions.core
Interface ArraySortedAssert<S,E>

Type Parameters:
S - the "self" type of this assertion class that must be a array type (e.g. arrays, collections).
Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.
E - the array element type.
All Known Implementing Classes:
BooleanArrayAssert, ByteArrayAssert, CharArrayAssert, DoubleArrayAssert, FloatArrayAssert, IntArrayAssert, LongArrayAssert, ObjectArrayAssert, ShortArrayAssert

public interface ArraySortedAssert<S,E>

Assertions applicable to primitive arrays or arrays of elements wether naturally Comparable or according to a given Comparator.

Note that the contract defined here is can't be totally applied to List (that's why its name is not SortedAssert), the differences being that we can't check that - for empty List - the list parameter is comparable or compatible with given comparator due to type erasure.

Author:
Joel Costigliola

Method Summary
 S isSorted()
          Verifies that the actual array is sorted into ascending order according to the natural ordering of its elements.
 S isSortedAccordingTo(Comparator<? extends E> comparator)
          Verifies that the actual array is sorted according to the given comparator.
 

Method Detail

isSorted

S isSorted()
Verifies that the actual array is sorted into ascending order according to the natural ordering of its elements.

All array elements must be primitive or implement the Comparable interface and must be mutually comparable (that is, e1.compareTo(e2) must not throw a ClassCastException for any elements e1 and e2 in the array), examples :

Empty or one element arrays are considered sorted (unless the array element type is not Comparable).

Returns:
this assertion object.
Throws:
AssertionError - if the actual array is not sorted into ascending order according to the natural ordering of its elements.
AssertionError - if the actual array is null.
AssertionError - if the actual array element type does not implement Comparable.
AssertionError - if the actual array elements are not mutually Comparable.

isSortedAccordingTo

S isSortedAccordingTo(Comparator<? extends E> comparator)
Verifies that the actual array is sorted according to the given comparator.
Empty arrays are considered sorted whatever the comparator is.
One element arrays are considered sorted if element is compatible with comparator, otherwise an AssertionError is thrown.

Parameters:
comparator - the Comparator used to compare array elements
Returns:
this assertion object.
Throws:
AssertionError - if the actual array is not sorted according to the given comparator.
AssertionError - if the actual array is null.
NullPointerException - if the given comparator is null.
AssertionError - if the actual array elements are not mutually comparabe according to given Comparator.


Copyright © 2007-2012 FEST (Fixtures for Easy Software Testing). All Rights Reserved.