com.almworks.integers

Interface WritableIntListIterator

All Superinterfaces:

IntIterable, IntIterator, IntListIterator, java.lang.Iterable<IntIterator>, java.util.Iterator<IntIterator>

All Known Implementing Classes:

AbstractWritableIntList.WritableIndexIterator, IntEmptyIterator

public interface WritableIntListIterator
extends IntListIterator

Nested Class Summary

Nested classes/interfaces inherited from interface com.almworks.integers.IntIterator

IntIterator.Single

Field Summary

Fields inherited from interface com.almworks.integers.IntIterator

EMPTY

Method Summary

Methods

Modifier and Type	Method and Description
int	get(int offset) Returns the value at a position relative to the current position.
boolean	hasValue()
int	index()
void	move(int offset) Changes the current position of the iterator.
void	remove() Removes an element at the current iterator position.
void	removeRange(int fromOffset, int toOffset) Removes a number of items from the collection.
void	set(int offset, int value) Will set the value in the list at a position relative to the current position.
int	value()

Methods inherited from interface com.almworks.integers.IntIterator

hasNext, nextValue

Methods inherited from interface com.almworks.integers.IntIterable

iterator

Methods inherited from interface java.util.Iterator

next

Method Detail

value

int value()
          throws java.util.NoSuchElementException,
                 java.lang.IllegalStateException

Specified by:

value in interface IntIterator

Throws:

java.lang.IllegalStateException - if remove() or removeRange(int, int) was previously called without subsequent advance.

java.util.NoSuchElementException - if iterator has never been advanced (Iterator.next() or IntIterator.nextValue() have never been called)

hasValue

boolean hasValue()

Specified by:

hasValue in interface IntIterator

Returns:

false if this iterator has never been advanced or the current value has been removed via remove() or removeRange(int, int). In other words, returns false if the subsequent call to value() will throw NoSuchElementException or IllegalStateException, otherwise true.

See Also:

value()

move

void move(int offset)
          throws java.util.NoSuchElementException,
                 java.lang.IllegalStateException

Description copied from interface: IntListIterator

Changes the current position of the iterator.

Specified by:

move in interface IntListIterator

Parameters:

offset - the difference between new and old iterator indices. Zero won't change iterator state. Positive value will move it to greater indices, negative - to smaller indices.

Throws:

java.lang.IllegalStateException - if remove() or removeRange(int, int) was previously called without subsequent advance.

java.util.NoSuchElementException

get

int get(int offset)
        throws java.util.NoSuchElementException,
               java.lang.IllegalStateException

Description copied from interface: IntListIterator

Returns the value at a position relative to the current position.

get(0) will return the same value as value(), get(-1) will return value at index()-1, etc.

Specified by:

get in interface IntListIterator

Throws:

java.lang.IllegalStateException - if remove() or removeRange(int, int) was previously called without subsequent advance.

java.util.NoSuchElementException

index

int index()
          throws java.util.NoSuchElementException,
                 java.lang.IllegalStateException

Specified by:

index in interface IntListIterator

Returns:

The current position of the iterator.
move(p) would change index by p, Iterator.next() and IntIterator.nextValue() would change it by 1.

Throws:

java.lang.IllegalStateException - if remove() or removeRange(int, int) was previously called without subsequent advance.

java.util.NoSuchElementException - if iterator has never been advanced (Iterator.next() or IntIterator.nextValue() weren't ever called)

set

void set(int offset,
       int value)
         throws java.util.NoSuchElementException,
                java.lang.IllegalStateException

Will set the value in the list at a position relative to the current position.

set(0, X) will set the value at index(), set(-1, X) will set the value at index()-1, etc

Throws:

java.lang.IllegalStateException - if remove() or removeRange(int, int) was previously called without subsequent advance.

java.util.NoSuchElementException

removeRange

void removeRange(int fromOffset,
               int toOffset)
                 throws java.util.NoSuchElementException,
                        java.lang.IllegalStateException

Removes a number of items from the collection. Boundaries fromOffset and toOffset are relative to current position, element at toOffset will not be removed (if there's any).

After calling this method, subsequent calls to any methods except hasValue(), hasNext(), next(), and nextValue() would throw IllegalStateException until iterator is advanced. Example: removeRange(-1,2) will remove the current element, elements at index()-1 and at index()+1, and the iterator will point at the element at index()+2 after it is advanced.

Throws:

java.lang.IllegalStateException - if remove() or removeRange() was previously called without subsequent advance.

java.util.NoSuchElementException

remove

void remove()
            throws java.util.NoSuchElementException,
                   java.lang.IllegalStateException

Removes an element at the current iterator position.

After calling this method, subsequent calls to any methods except hasValue(), hasNext(), next(), and nextValue() would throw IllegalStateException until iterator is advanced. After calling this method and subsequent advance, iterator would point at element which is next to removed one.

Specified by:

remove in interface java.util.Iterator<IntIterator>

Throws:

java.util.NoSuchElementException - if iterator has never been advanced.

java.lang.IllegalStateException - if remove() or removeRange() were previously called without subsequent advance.