org.leialearns.utilities

Class TypedIterable<T>

java.lang.Object

org.leialearns.utilities.TypedIterable<T>

Type Parameters:

T - The base type of the iterable

All Implemented Interfaces:

Iterable<T>, HasWrappedIterable

Direct Known Subclasses:

TransformingIterable

public class TypedIterable<T>
extends Object
implements Iterable<T>, HasWrappedIterable

Adds a bit of run-time type information to an iterable.

Constructor Summary

Constructors

Constructor and Description
TypedIterable(Class<T> type, Iterable<?> iterable) Creates a new TypedIterable instance.
TypedIterable(Iterable<T> iterable, Class<T> type) Creates a new TypedIterable instance.

Method Summary

Methods

Modifier and Type	Method and Description
T	first() Returns the first item of this iterable.
Class<T>	getType() Returns the base type of this iterable.
Iterable<?>	getWrappedIterable() Returns the backing iterable.
boolean	isEmpty() Returns a flag that indicates whether this iterable is empty.
Iterator<T>	iterator() Returns an iterator for this iterable.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypedIterable

public TypedIterable(Iterable<T> iterable,
             Class<T> type)

Creates a new TypedIterable instance.

Parameters:

iterable - The backing iterable

type - The base type of the iterable

TypedIterable

public TypedIterable(Class<T> type,
             Iterable<?> iterable)

Creates a new TypedIterable instance. Performs a cast on each item to make sure that the elements to the backing iterable conform to the specified type.

Parameters:

type - The base type of the iterable

iterable - The backing iterable

Method Detail

iterator

public Iterator<T> iterator()

Returns an iterator for this iterable.

Specified by:

iterator in interface Iterable<T>

Returns:

An iterator for this iterable

getType

public Class<T> getType()

Returns the base type of this iterable.

Returns:

The base type of this iterable

getWrappedIterable

public Iterable<?> getWrappedIterable()

Returns the backing iterable.

Specified by:

getWrappedIterable in interface HasWrappedIterable

Returns:

The backing iterable

first

public T first()

Returns the first item of this iterable.

Returns:

The first item of this iterable

isEmpty

public boolean isEmpty()

Returns a flag that indicates whether this iterable is empty.

Returns:

true if this iterable contains no elements; false otherwise