gshute.util
Class Iterators

java.lang.Object
  |
  +--gshute.util.Iterators

public class Iterators

extends java.lang.Object

Class Iterators is a factory class that provides static methods for construction iterators. for constructing iterators purposes.

Inner Class Summary

static class	Iterators.ArrayIterator Class ArrayIterator implements the ListIterator interface for iterations on arrays.
static class	Iterators.ConcatenatedIterator Class ConcatenatedIterator provides a mechanism for concatenating two iterators.
static class	Iterators.SingleItemIterator Class SingleItemIterator implements the ListIterator interface for iterations whose iteration sequence contains only one item.

Field Summary

protected static java.util.ListIterator

emptyIterator emptyIterator is the singleton empty iterator.

Method Summary

static java.util.Iterator	concat(java.util.Iterator iter1, java.util.Iterator iter2) Iterators.concat(iter1, iter2) returns an iterator whose iteration sequence is the concatenation of the iteration sequences of iter1 and iter2.
static java.util.ListIterator	getArrayIterator(java.lang.Object[] ar) Iterators.getArrayIterator(Object[] ar) returns an iterator for the entries of ar.
static java.util.ListIterator	getEmptyIterator() Iterators.getEmptyIterator() returns an empty list iterator.
static java.util.ListIterator	getSingleItemIterator(java.lang.Object o) Iterators.getSingleItemIterator(o) returns an iterator whose iteration sequence contains only the item o.
static java.util.Enumeration	toEnumeration(java.util.Iterator iter) Iterators.toEnumeration(iter) returns iter wrapped as an enumeration.
static java.util.Iterator	toIterator(java.util.Enumeration enum) Iterators.toIterator(enum) returns enum wrapped as an iterator.

Methods inherited from class java.lang.Object

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

Field Detail

emptyIterator

protected static java.util.ListIterator emptyIterator

emptyIterator is the singleton empty iterator.

Method Detail

getEmptyIterator

public static java.util.ListIterator getEmptyIterator()

Iterators.getEmptyIterator() returns an empty list iterator.

toEnumeration

public static java.util.Enumeration toEnumeration(java.util.Iterator iter)

Iterators.toEnumeration(iter) returns iter wrapped as an enumeration.

toIterator

public static java.util.Iterator toIterator(java.util.Enumeration enum)

Iterators.toIterator(enum) returns enum wrapped as an iterator. The iterator does not implement the remove() method. It throws an UnsupportedOperationException when remove() is invoked.

getArrayIterator

public static java.util.ListIterator getArrayIterator(java.lang.Object[] ar)

Iterators.getArrayIterator(Object[] ar) returns an iterator for the entries of ar. If ar is null then an empty iterator is returned.

getSingleItemIterator

public static java.util.ListIterator getSingleItemIterator(java.lang.Object o)

Iterators.getSingleItemIterator(o) returns an iterator whose iteration sequence contains only the item o. A single item iterator is primarily useful for adding items into an iteration sequence using concatenated iterators.

concat

public static java.util.Iterator concat(java.util.Iterator iter1,
                                        java.util.Iterator iter2)

Iterators.concat(iter1, iter2) returns an iterator whose iteration sequence is the concatenation of the iteration sequences of iter1 and iter2. Both iter1 and iter2 must be non-null, but they may be empty iterators.