org.plumelib.util

Class CollectionsPlume.RemoveFirstAndLastIterator<T>

java.lang.Object

org.plumelib.util.CollectionsPlume.RemoveFirstAndLastIterator<T>

All Implemented Interfaces:

java.util.Iterator<T>

Enclosing class:

CollectionsPlume

public static final class CollectionsPlume.RemoveFirstAndLastIterator<T>
extends java.lang.Object
implements java.util.Iterator<T>

Returns an iterator just like its argument, except that the first and last elements are removed. They can be accessed via the getFirst() and getLast() methods.

Constructor Summary

Constructors

Constructor and Description
RemoveFirstAndLastIterator(java.util.Iterator<T> itor) Create an iterator just like itor, except without its first and last elements.

Method Summary

Modifier and Type	Method and Description
T	getFirst() Return the first element of the iterator that was used to construct this.
T	getLast() Return the last element of the iterator that was used to construct this.
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

RemoveFirstAndLastIterator

public RemoveFirstAndLastIterator(java.util.Iterator<T> itor)

Create an iterator just like itor, except without its first and last elements.

Parameters:

itor - an itorator whose first and last elements to discard

Method Detail

hasNext

public boolean hasNext(@GuardSatisfied CollectionsPlume.RemoveFirstAndLastIterator<T> this)

Specified by:

hasNext in interface java.util.Iterator<T>

next

public T next(@GuardSatisfied CollectionsPlume.RemoveFirstAndLastIterator<T> this)

Specified by:

next in interface java.util.Iterator<T>

getFirst

public T getFirst()

Return the first element of the iterator that was used to construct this. This value is not part of this iterator (unless the original iterator would have returned it multiple times).

Returns:

the first element of the iterator that was used to construct this

getLast

public T getLast()

Return the last element of the iterator that was used to construct this. This value is not part of this iterator (unless the original iterator would have returned it multiple times).

Throws an error unless the RemoveFirstAndLastIterator has already been iterated all the way to its end (so the delegate is pointing to the last element).

Returns:

the last element of the iterator that was used to construct this.

remove

public void remove(@GuardSatisfied CollectionsPlume.RemoveFirstAndLastIterator<T> this)

Specified by:

remove in interface java.util.Iterator<T>