com.carrotsearch.hppcrt.lists

Class IntLinkedList.ValueIterator

java.lang.Object

com.carrotsearch.hppcrt.AbstractIterator<IntCursor>

com.carrotsearch.hppcrt.lists.IntLinkedList.ValueIterator

All Implemented Interfaces:

java.util.Iterator<IntCursor>

Direct Known Subclasses:

IntLinkedList.DescendingValueIterator

Enclosing class:

IntLinkedList

public class IntLinkedList.ValueIterator
extends AbstractIterator<IntCursor>

A specialized iterator implementation for IntLinkedList.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
IntCursor	cursor

Constructor Summary

Constructors

Constructor and Description
ValueIterator()

Method Summary

Modifier and Type	Method and Description
IntLinkedList.ValueIterator	delete() Delete the current iterator position, and moves to the next valid element after this removal, with respect to the forward iteration.
protected IntCursor	fetch() Fetch next element.
int	getNext() Get the next element value with respect to the forward iteration, without moving the iterator.
int	getPrevious() Get the previous element value with respect to the forward iteration,
IntLinkedList.ValueIterator	gotoHead() Reset the iterator to the "head", returning itself for chaining.
IntLinkedList.ValueIterator	gotoNext() Analog to AbstractIterator.next(), move the iterator to the next element, with respect to the forward iteration, returning itself for chaining.
IntLinkedList.ValueIterator	gotoPrevious() Move the iterator to the previous element, with respect to the forward iteration, returning itself for chaining.
IntLinkedList.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(int e1) Insert e1 after the iterator position, without moving the iterator.
void	insertBefore(int e1) Insert e1 before the iterator position, without moving the iterator.
int	removeNext() Removes the next element, without moving the iterator.
int	removePrevious() Removes the previous element, without moving the iterator.
void	set(int 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 IntCursor cursor

Constructor Detail

ValueIterator

public ValueIterator()

Method Detail

fetch

protected IntCursor 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<IntCursor>

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 IntLinkedList.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 IntLinkedList.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 IntLinkedList.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 IntLinkedList.ValueIterator gotoPrevious()

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

getNext

public int 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 int getPrevious()

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

Throws:

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

removeNext

public int 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 int 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(int 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(int 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(int 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 IntLinkedList.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.