com.carrotsearch.hppcrt.lists

Class ObjectLinkedList.ValueIterator

java.lang.Object

com.carrotsearch.hppcrt.AbstractIterator<ObjectCursor<KType>>

com.carrotsearch.hppcrt.lists.ObjectLinkedList.ValueIterator

All Implemented Interfaces:

java.util.Iterator<ObjectCursor<KType>>

Direct Known Subclasses:

ObjectLinkedList.DescendingValueIterator

Enclosing class:

ObjectLinkedList<KType>

public class ObjectLinkedList.ValueIterator
extends AbstractIterator<ObjectCursor<KType>>

A specialized iterator implementation for ObjectLinkedList.iterator()s.

 
 Important: NEVER USE java.util.Iterator methods directly, only use the specialized methods instead !
 Iterator.hasNext() and Iterator.next() are only for enhanced-loop support, using them
 directly will lead to unpredictable results !
 

Field Summary

Fields

Modifier and Type	Field and Description
ObjectCursor<KType>	cursor

Constructor Summary

Constructors

Constructor and Description
ValueIterator()

Method Summary

Modifier and Type	Method and Description
ObjectLinkedList.ValueIterator	delete() Delete the current iterator position, and moves to the next valid element after this removal, with respect to the forward iteration.
protected ObjectCursor<KType>	fetch() Fetch next element.
KType	getNext() Get the next element value with respect to the forward iteration, without moving the iterator.
KType	getPrevious() Get the previous element value with respect to the forward iteration,
ObjectLinkedList.ValueIterator	gotoHead() Reset the iterator to the "head", returning itself for chaining.
ObjectLinkedList.ValueIterator	gotoNext() Analog to AbstractIterator.next(), move the iterator to the next element, with respect to the forward iteration, returning itself for chaining.
ObjectLinkedList.ValueIterator	gotoPrevious() Move the iterator to the previous element, with respect to the forward iteration, returning itself for chaining.
ObjectLinkedList.ValueIterator	gotoTail() Reset the iterator to the "tail", returning itself for chaining.
boolean	hasAfter() Analog to AbstractIterator.hasNext(), returns true if there is an element after the current position, with respect to the forward iteration.
boolean	hasBefore() Inverse of hasAfter(), i.e. returns true if there is an element before the current position, with respect to the forward iteration.
void	insertAfter(KType e1) Insert e1 after the iterator position, without moving the iterator.
void	insertBefore(KType e1) Insert e1 before the iterator position, without moving the iterator.
KType	removeNext() Removes the next element, without moving the iterator.
KType	removePrevious() Removes the previous element, without moving the iterator.
void	set(KType e1) Set e1 to the current iterator (position), without moving the iterator.

Methods inherited from class com.carrotsearch.hppcrt.AbstractIterator

done, hasNext, next, release, 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

Field Detail

cursor

public final ObjectCursor<KType> cursor

Constructor Detail

ValueIterator

public ValueIterator()

Method Detail

fetch

protected ObjectCursor<KType> fetch()

Description copied from class: AbstractIterator

Fetch next element. The implementation must return AbstractIterator.done() when all elements have been fetched.

Specified by:

fetch in class AbstractIterator<ObjectCursor<KType>>

hasAfter

public boolean hasAfter()

Analog to AbstractIterator.hasNext(), returns true if there is an element after the current position, with respect to the forward iteration. Always false if the list is empty. (i.e no next element)

See Also:

hasBefore()

hasBefore

public boolean hasBefore()

Inverse of hasAfter(), i.e. returns true if there is an element before the current position, with respect to the forward iteration. Always false if the list is empty. (i.e no previous element)

See Also:

hasAfter()

gotoHead

public ObjectLinkedList.ValueIterator gotoHead()

Reset the iterator to the "head", returning itself for chaining. Head is such that gotoHead().gotoNext() points to the first element of the list, with respect to the forward iteration. (if the list is not empty)

gotoTail

public ObjectLinkedList.ValueIterator gotoTail()

Reset the iterator to the "tail", returning itself for chaining. Tail is such that gotoTail().gotoPrevious() points to the last element of the list, with respect to the forward iteration. (if the list is not empty)

gotoNext

public ObjectLinkedList.ValueIterator gotoNext()

Analog to AbstractIterator.next(), move the iterator to the next element, with respect to the forward iteration, returning itself for chaining.

gotoPrevious

public ObjectLinkedList.ValueIterator gotoPrevious()

Move the iterator to the previous element, with respect to the forward iteration, returning itself for chaining.

getNext

public KType getNext()

Get the next element value with respect to the forward iteration, without moving the iterator.

Throws:

java.util.NoSuchElementException - if no such element exists.

getPrevious

public KType getPrevious()

Get the previous element value with respect to the forward iteration,

Throws:

java.util.NoSuchElementException - if no such element exists.

removeNext

public KType removeNext()

Removes the next element, without moving the iterator. returns the removed element.

Throws:

java.util.NoSuchElementException - if no such element exists. (because there is no element left after)

removePrevious

public KType removePrevious()

Removes the previous element, without moving the iterator. Returns the removed element.

Throws:

java.util.NoSuchElementException - if no such element exists. (because there is no element left before)

insertBefore

public void insertBefore(KType e1)

Insert e1 before the iterator position, without moving the iterator.

Throws:

java.lang.IndexOutOfBoundsException - if insertion is impossible, because we are pointing at head.

insertAfter

public void insertAfter(KType e1)

Insert e1 after the iterator position, without moving the iterator.

Throws:

java.lang.IndexOutOfBoundsException - if insertion is impossible, because we are pointing at tail.

set

public void set(KType e1)

Set e1 to the current iterator (position), without moving the iterator.

Throws:

java.lang.IndexOutOfBoundsException - if set is impossible, because we are pointing either at head or tail.

delete

public ObjectLinkedList.ValueIterator delete()

Delete the current iterator position, and moves to the next valid element after this removal, with respect to the forward iteration. Returns the iterator itself for chaining.

Throws:

java.lang.IndexOutOfBoundsException - if delete is impossible, because we are pointing either at head or tail.