edu.rice.cs.plt.iter
Class ImmutableIterable<T>

java.lang.Object
  edu.rice.cs.plt.iter.AbstractIterable<T>
      edu.rice.cs.plt.iter.ImmutableIterable<T>

All Implemented Interfaces:

OptimizedLastIterable<T>, SizedIterable<T>, Composite, java.io.Serializable, java.lang.Iterable<T>

public class ImmutableIterable<T>
extends AbstractIterable<T>
implements SizedIterable<T>, OptimizedLastIterable<T>, Composite, java.io.Serializable

Wraps an iterable in an immutable interface, thus allowing internal data structures to be treated by clients as iterables without allowing access (via casting) to their mutating methods. Also ensures that the Iterator.remove() method of the provided Iterator is not supported. Note that only only this interface with the data is immutable -- if the original data structure is mutable, a client with direct access to that structure can still mutate it. To guarantee that no mutation will take place, use a SnapshotIterable instead, which makes an immutable copy.

See Also:

Serialized Form

Constructor Summary

ImmutableIterable(java.lang.Iterable<? extends T> iterable)

Method Summary

int	compositeHeight() Get the maximum path length from this node to a leaf.
int	compositeSize() Get the number of nodes in the tree rooted at this node.
boolean	hasFixedSize() true if this iterable is known to have a fixed size.
boolean	isEmpty() Whether the iterable does not contain any elements.
boolean	isInfinite() true if the iterable is known to have infinite size.
boolean	isStatic() true if this iterable is unchanging.
ImmutableIterator<T>	iterator()
T	last() Get the last element of the list.
static <T> ImmutableIterable<T>	make(java.lang.Iterable<? extends T> iterable) Call the constructor (allows T to be inferred)
int	size() Compute the number of elements in the iterable.
int	size(int bound) Compute the number of elements in the iterable, up to the given bound.

Methods inherited from class edu.rice.cs.plt.iter.AbstractIterable

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImmutableIterable

public ImmutableIterable(java.lang.Iterable<? extends T> iterable)

Method Detail

iterator

public ImmutableIterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

compositeHeight

public int compositeHeight()

Description copied from interface: Composite

Get the maximum path length from this node to a leaf.

Specified by:

compositeHeight in interface Composite

compositeSize

public int compositeSize()

Description copied from interface: Composite

Get the number of nodes in the tree rooted at this node. Always 1 or greater.

Specified by:

compositeSize in interface Composite

isEmpty

public boolean isEmpty()

Description copied from interface: SizedIterable

Whether the iterable does not contain any elements.

Specified by:

isEmpty in interface SizedIterable<T>

size

public int size()

Description copied from interface: SizedIterable

Compute the number of elements in the iterable. If the size is infinite or too large to be represented as an int, Integer.MAX_VALUE should be returned. Otherwise, next() may be safely invoked on the iterator exactly this number of times.

Specified by:

size in interface SizedIterable<T>

size

public int size(int bound)

Description copied from interface: SizedIterable

Compute the number of elements in the iterable, up to the given bound. If the size is infinite or greater than bound, bound is returned.

Specified by:

size in interface SizedIterable<T>

Parameters:

bound - Maximum result. Assumed to be nonnegative.

isInfinite

public boolean isInfinite()

Description copied from interface: SizedIterable

true if the iterable is known to have infinite size. If true, an iterator over the iterable in its current state will never return false from hasNext().

Specified by:

isInfinite in interface SizedIterable<T>

hasFixedSize

public boolean hasFixedSize()

Description copied from interface: SizedIterable

true if this iterable is known to have a fixed size. This is the case if the iterable is immutable, or if changes can only replace values, not remove or add them. An infinite iterable may be fixed if it is guaranteed to never become finite.

Specified by:

hasFixedSize in interface SizedIterable<T>

isStatic

public boolean isStatic()

Description copied from interface: SizedIterable

true if this iterable is unchanging. This implies that hasFixedSize() is true, and that iterator() will always return the same (either == or equal() and immutable) elements in the same order. ("Immutable" here means that equals() invocations are consistent over time -- if two objects are equal, they will never become inequal, and vice versa.)

Specified by:

isStatic in interface SizedIterable<T>

last

public T last()

Description copied from interface: OptimizedLastIterable

Get the last element of the list. Assumed to execute more quickly than a traversal over all elements.

Specified by:

last in interface OptimizedLastIterable<T>

make

public static <T> ImmutableIterable<T> make(java.lang.Iterable<? extends T> iterable)

Call the constructor (allows T to be inferred)