Apache Commons Collections 4.4 · org.apache.commons.collections4.iterators.BoundedIterator

Modifier and Type	Field and Description
private final Iterator<? extends E>	iterator The iterator being decorated.
private final long	max The max number of elements to return
private final long	offset The offset to bound the first element return
private long	pos The position of the current element

Access	Constructor and Description
public	BoundedIterator(final Iterator<? extends E> the iterator to be decorated iterator, final long the index of the first element of the decorated iterator to return offset, final long the maximum number of elements of the decorated iterator to return max) Decorates the specified iterator to return at most the given number of elements, skipping all elements until the iterator reaches the position at `offset`.

Method Summary

Modifier and Type	Method and Description
private boolean	Returns: `true` if the iterator is within its bounds, `false` otherwise checkBounds() Checks whether the iterator is still within its bounded range.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
private void	init() Advances the underlying iterator to the beginning of the bounded range.
public E	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

iterator	back to summary
private final Iterator<? extends E> iterator The iterator being decorated.

max	back to summary
private final long max The max number of elements to return

offset	back to summary
private final long offset The offset to bound the first element return

pos	back to summary
private long pos The position of the current element

Constructor Detail

BoundedIterator back to summary

BoundedIterator	back to summary
public BoundedIterator(final Iterator<? extends E> iterator, final long offset, final long max) Decorates the specified iterator to return at most the given number of elements, skipping all elements until the iterator reaches the position at `offset`. The iterator is immediately advanced until it reaches the position at `offset`, incurring O(n) time. Parameters iterator:Iterator<? extends E> the iterator to be decorated offset:long the index of the first element of the decorated iterator to return max:long the maximum number of elements of the decorated iterator to return Exceptions NullPointerException: if iterator is null IllegalArgumentException: if either offset or max is negative

public BoundedIterator(final Iterator<? extends E> iterator, final long offset, final long max)

Decorates the specified iterator to return at most the given number of elements, skipping all elements until the iterator reaches the position at offset.

The iterator is immediately advanced until it reaches the position at offset, incurring O(n) time.

Parameters

iterator:Iterator<? extends E>: the iterator to be decorated
offset:long: the index of the first element of the decorated iterator to return
max:long: the maximum number of elements of the decorated iterator to return

Exceptions

NullPointerException:: if iterator is null
IllegalArgumentException:: if either offset or max is negative

Method Detail

checkBounds back to summary

checkBounds	back to summary
private boolean checkBounds() Checks whether the iterator is still within its bounded range. Returns:boolean `true` if the iterator is within its bounds, `false` otherwise

private boolean checkBounds()

Checks whether the iterator is still within its bounded range.

Returns:boolean: true if the iterator is within its bounds, false otherwise

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

init	back to summary
private void init() Advances the underlying iterator to the beginning of the bounded range.

next	back to summary
public E next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:E the next element in the iteration Annotations @Override

back to summary

public E next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:E

the next element in the iteration

Annotations

@Override

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. In case an offset other than 0 was specified, the underlying iterator will be advanced to this position upon creation. A call to `remove()` will still result in an `IllegalStateException` if no explicit call to `next()` has been made prior to calling `remove()`. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

In case an offset other than 0 was specified, the underlying iterator will be advanced to this position upon creation. A call to remove() will still result in an IllegalStateException if no explicit call to next() has been made prior to calling remove().

Annotations

@Override

public Class BoundedIterator<E>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail