org.assertj.core.util

Class IterableUtil

java.lang.Object

org.assertj.core.util.GroupFormatUtil

org.assertj.core.util.IterableUtil

public final class IterableUtil
extends GroupFormatUtil

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isNullOrEmpty(Iterable<?> iterable) Indicates whether the given Iterable is null or empty.
static String	multiLineFormat(Representation representation, Iterable<?> iterable)
static <T> List<T>	nonNullElementsIn(Iterable<? extends T> i) Returns all the non-null elements in the given Iterable.
static String	singleLineFormat(Representation representation, Iterable<?> iterable, String start, String end)
static int	sizeOf(Iterable<?> iterable) Returns the size of the given Iterable.
static String	smartFormat(Representation representation, Iterable<?> iterable) Returns the String representation of the given Iterable, or null if the given Iterable is null.
static <T> T[]	toArray(Iterable<? extends T> iterable) Create an array from an Iterable.
static <T> T[]	toArray(Iterable<? extends T> iterable, Class<T> type) Create an typed array from an Iterable.

Methods inherited from class org.assertj.core.util.GroupFormatUtil

setMaxLengthForSingleLineDescription

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isNullOrEmpty

public static boolean isNullOrEmpty(Iterable<?> iterable)

Indicates whether the given Iterable is null or empty.

Parameters:

iterable - the given Iterable to check.

Returns:

true if the given Iterable is null or empty, otherwise false.

sizeOf

public static int sizeOf(Iterable<?> iterable)

Returns the size of the given Iterable.

Parameters:

iterable - the Iterable to get size.

Returns:

the size of the given Iterable.

Throws:

NullPointerException - if given Iterable is null.

nonNullElementsIn

public static <T> List<T> nonNullElementsIn(Iterable<? extends T> i)

Returns all the non-null elements in the given Iterable.

Type Parameters:

T - the type of elements of the Iterable.

Parameters:

i - the given Iterable.

Returns:

all the non-null elements in the given Iterable. An empty list is returned if the given Iterable is null.

Since:

1.1.3

toArray

public static <T> T[] toArray(Iterable<? extends T> iterable)

Create an array from an Iterable.

Note: this method will return Object[]. If you require a typed array please use toArray(Iterable, Class). It's main usage is to keep the generic type for chaining call like in:

 public S containsOnlyElementsOf(Iterable iterable) {
   return containsOnly(toArray(iterable));
 }
 

Type Parameters:

T - the type of elements of the Iterable.

Parameters:

iterable - an Iterable to translate in an array.

Returns:

all the elements from the given Iterable in an array. null if given Iterable is null.

toArray

public static <T> T[] toArray(Iterable<? extends T> iterable,
              Class<T> type)

Create an typed array from an Iterable.

Type Parameters:

T - the type of elements of the Iterable.

Parameters:

iterable - an Iterable to translate in an array.

type - the type of the resulting array.

Returns:

all the elements from the given Iterable in an array. null if given Iterable is null.

smartFormat

public static String smartFormat(Representation representation,
                 Iterable<?> iterable)

Returns the String representation of the given Iterable, or null if the given Iterable is null.

The Iterable will be formatted to a single line if it does not exceed 100 char, otherwise each elements will be formatted on a new line with 4 space indentation.

Parameters:

representation -

iterable - the Iterable to format.

Returns:

the String representation of the given Iterable.

singleLineFormat

public static String singleLineFormat(Representation representation,
                      Iterable<?> iterable,
                      String start,
                      String end)

multiLineFormat

public static String multiLineFormat(Representation representation,
                     Iterable<?> iterable)