org.trancecode.collection

Class TcIterables

java.lang.Object

org.trancecode.collection.TcIterables

public final class TcIterables
extends Object

Utility methods related to Iterable.

Author:

Herve Quiroz

Method Summary

Methods

Modifier and Type	Method and Description
static <T> Iterable<T>	append(Iterable<T> iterable, T... elements)
static <T> Iterable<T>	append(Iterable<T> iterable, T element)
static <F,T> Iterable<T>	applyFunctions(Iterable<com.google.common.base.Function<F,T>> functions, F argument) Compute a sequence of results by applying each function form the list to the same argument.
static <T> Iterable<T>	concurrentModifiable(List<T> sequence)
static <T> Iterable<T>	getDescendants(Iterable<T> parentElements, com.google.common.base.Function<T,Iterable<T>> getChildFunction)
static <T> Iterable<T>	getDescendants(T parentElement, com.google.common.base.Function<T,Iterable<T>> getChildFunction)
static <T> T	getFirst(Iterable<T> elements)
static <T> T	getFirst(Iterable<T> elements, T defaultElement)
static <T> T	getFirstNonNull(Iterable<T> elements, T defaultValue) Returns the first non-null element from the specified sequence, or the specified default value if all elements from the sequence were null.
static <T> T	getFirstNonNull(T... elements) Returns the first non-null element from the specified sequence, or null if all elements from the sequence were null.
static <T> T	getLast(Iterable<T> elements) Get the last argument from a sequence, or null if there is no such last element.
static <T> T	getLast(Iterable<T> elements, T defaultElement) Get the last argument from a sequence, or defaultElement if there is no such last element.
static <T> Iterable<T>	prepend(Iterable<T> iterable, T... elements)
static <T> Iterable<T>	removeAll(BlockingQueue<T> fromQueue) Returns an Iterable that contains the elements from the queue.
static boolean	removeAll(Iterable<?> iterable)
static <T> Iterable<T>	until(Iterable<T> elements, com.google.common.base.Predicate<T> predicate) Returns the elements from the passed sequence up to the first element that matches the passed predicate (this element is excluded from the result sequence).

Methods inherited from class java.lang.Object

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

Method Detail

getLast

@ReturnsNullable
public static <T> T getLast(Iterable<T> elements)

Get the last argument from a sequence, or null if there is no such last element.

getLast

@ReturnsNullable
public static <T> T getLast(Iterable<T> elements,
                            T defaultElement)

Get the last argument from a sequence, or defaultElement if there is no such last element.

getFirst

public static <T> T getFirst(Iterable<T> elements)

getFirst

public static <T> T getFirst(Iterable<T> elements,
             T defaultElement)

append

public static <T> Iterable<T> append(Iterable<T> iterable,
                     T element)

append

public static <T> Iterable<T> append(Iterable<T> iterable,
                     T... elements)

prepend

public static <T> Iterable<T> prepend(Iterable<T> iterable,
                      T... elements)

applyFunctions

public static <F,T> Iterable<T> applyFunctions(Iterable<com.google.common.base.Function<F,T>> functions,
                               F argument)

Compute a sequence of results by applying each function form the list to the same argument.

getDescendants

public static <T> Iterable<T> getDescendants(Iterable<T> parentElements,
                             com.google.common.base.Function<T,Iterable<T>> getChildFunction)

getDescendants

public static <T> Iterable<T> getDescendants(T parentElement,
                             com.google.common.base.Function<T,Iterable<T>> getChildFunction)

removeAll

public static boolean removeAll(Iterable<?> iterable)

concurrentModifiable

public static <T> Iterable<T> concurrentModifiable(List<T> sequence)

See Also:

TcIterators.concurrentModifiable(List)

until

public static <T> Iterable<T> until(Iterable<T> elements,
                    com.google.common.base.Predicate<T> predicate)

Returns the elements from the passed sequence up to the first element that matches the passed predicate (this element is excluded from the result sequence).

Returned Iterable will throw NoSuchElementException if the predicate does not match for any element from the sequence.

removeAll

public static <T> Iterable<T> removeAll(BlockingQueue<T> fromQueue)

Returns an Iterable that contains the elements from the queue.

See Also:

TcIterators.removeAll(BlockingQueue)

getFirstNonNull

public static <T> T getFirstNonNull(Iterable<T> elements,
                    T defaultValue)

Returns the first non-null element from the specified sequence, or the specified default value if all elements from the sequence were null.

getFirstNonNull

public static <T> T getFirstNonNull(T... elements)

Returns the first non-null element from the specified sequence, or null if all elements from the sequence were null.