Package de.xima.fc.utils

Class IterableUtils

java.lang.Object

de.xima.fc.utils.IterableUtils

public final class IterableUtils
extends Object

Additional utilities for Iterables not found in other libraries.

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IterableUtils.Indexed<T>	Represents an item with an index.

Constructor Summary

Constructors

Constructor	Description
IterableUtils()

Method Summary

Modifier and Type	Method	Description
static <T> T	firstOrNull(Iterable<T> iterable)	Similar to the first method from Apache Commons, but returns null instead of throwing if the iterable is empty.
static <T> Iterable<IterableUtils.Indexed<T>>	withIndex(Iterable<T> iterable)	Wraps an iterable and adds the index to each element.

Methods inherited from class java.lang.Object

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

Constructor Details

IterableUtils

public IterableUtils()

Method Details

withIndex

public static <T>
Iterable<IterableUtils.Indexed<T>> withIndex(Iterable<T> iterable)

Wraps an iterable and adds the index to each element.

Type Parameters:

T - Type of the elements in the iterable.

Parameters:

iterable - Iterable to wrap.

Returns:

An iterable that iterates over the same elements, but with a 0-based index added to each element.

firstOrNull

public static <T> T firstOrNull(Iterable<T> iterable)

Similar to the first method from Apache Commons, but returns null instead of throwing if the iterable is empty.

Type Parameters:

T - Type of the items in the iterable.

Parameters:

iterable - Iterable to process.

Returns:

The first item in the iterable, or null if either the iterable is null or it contains no items.