edu.mit.jmwe.util

Class LimitedIterator<T>

java.lang.Object

edu.mit.jmwe.util.LimitedIterator<T>

Type Parameters:

T - the type of objects that the iterator returns

All Implemented Interfaces:

java.util.Iterator<T>

public class LimitedIterator<T>
extends java.lang.Object
implements java.util.Iterator<T>

Wrapper for a given iterator that will return a limited number of elements from that iterator.

Since:

jMWE 1.0.0

Version:

$Id: LimitedIterator.java 267 2011-05-05 19:22:32Z markaf $

Author:

M.A. Finlayson

Constructor Summary

Constructors

Constructor and Description
LimitedIterator(java.util.Iterator<? extends T> backingItr, int limit) Constructs the limited iterator from a backing iterator and a limit that determines how many of the backing iterator's elements will be returned by the limited iterator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
T	next()
void	remove()

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

Constructor Detail

LimitedIterator

public LimitedIterator(java.util.Iterator<? extends T> backingItr,
                       int limit)

Constructs the limited iterator from a backing iterator and a limit that determines how many of the backing iterator's elements will be returned by the limited iterator.

Parameters:

backingItr - the iterator that will be used to back this iterator. May not be null.

limit - the number of elements that will be returned by the limited iterator. If the limit is zero or negative, there is no limit on the number of items returned.

Throws:

java.lang.NullPointerException - if the backing iterator is null.

Since:

jMWE 1.0.0

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T>

next

public T next()

Specified by:

next in interface java.util.Iterator<T>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<T>