javatools.datatypes

Class CombinedIterator<T>

java.lang.Object

javatools.datatypes.CombinedIterator<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>, Iterator<T>

public class CombinedIterator<T>
extends Object
implements Iterator<T>, Iterable<T>, Closeable

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The class combines multiple iterators to one iterator. The nice thing about it: The object is an Iterator as well as an Iterable, i.e. it can be used in a for-each-loop.
Example:

         for(Object o : new CombinedIterator(list1.iterator(),list2.iterator()))
               process(o);
   

Constructor Summary

Constructors

Constructor and Description
CombinedIterator() Creates an empty CombinedIterator
CombinedIterator(Collection<Iterable<? extends T>> its) Creates a CombinedIterator from some iterators
CombinedIterator(Iterable<? extends T> i) Adds a set
CombinedIterator(Iterator<? extends T>... its) Creates a CombinedIterator from some iterators (may give a (useless) Java compiler warning)
CombinedIterator(Iterator<? extends T> i1) Creates a CombinedIterator from one iterator
CombinedIterator(Iterator<? extends T> i1, Iterator<? extends T> i2) Creates a CombinedIterator two iterators
CombinedIterator(Iterator<? extends T> i1, Iterator<? extends T> i2, Iterator<? extends T> i3) Creates a CombinedIterator three iterators
CombinedIterator(T i) Adds a set

Method Summary

Modifier and Type	Method and Description
CombinedIterator<T>	add(Iterable<? extends T> i) Adds a set
CombinedIterator<T>	add(Iterator<? extends T> i) Adds an iterator
CombinedIterator<T>	add(T i) Adds a value
void	close() Closes all iterators (if closeable)
boolean	hasNext() TRUE if there are more elements
Iterator<T>	iterator() Returns this
T	next() Returns next
void	remove() Removes the current item

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CombinedIterator

public CombinedIterator()

Creates an empty CombinedIterator

CombinedIterator

public CombinedIterator(Iterator<? extends T> i1,
                        Iterator<? extends T> i2)

Creates a CombinedIterator two iterators

CombinedIterator

public CombinedIterator(Iterator<? extends T> i1)

Creates a CombinedIterator from one iterator

CombinedIterator

public CombinedIterator(Iterator<? extends T> i1,
                        Iterator<? extends T> i2,
                        Iterator<? extends T> i3)

Creates a CombinedIterator three iterators

CombinedIterator

public CombinedIterator(Iterable<? extends T> i)

Adds a set

CombinedIterator

public CombinedIterator(T i)

Adds a set

CombinedIterator

public CombinedIterator(Iterator<? extends T>... its)

Creates a CombinedIterator from some iterators (may give a (useless) Java compiler warning)

CombinedIterator

public CombinedIterator(Collection<Iterable<? extends T>> its)

Creates a CombinedIterator from some iterators

Method Detail

add

public CombinedIterator<T> add(Iterator<? extends T> i)

Adds an iterator

add

public CombinedIterator<T> add(T i)

Adds a value

add

public CombinedIterator<T> add(Iterable<? extends T> i)

Adds a set

hasNext

public boolean hasNext()

TRUE if there are more elements

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Returns next

Specified by:

next in interface Iterator<T>

iterator

public Iterator<T> iterator()

Returns this

Specified by:

iterator in interface Iterable<T>

remove

public void remove()

Removes the current item

Specified by:

remove in interface Iterator<T>

close

public void close()

Closes all iterators (if closeable)

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable