org.apache.commons.collections.primitives
Interface ByteListIterator

All Superinterfaces:

ByteIterator

All Known Implementing Classes:

ListIteratorByteListIterator, org.apache.commons.collections.primitives.decorators.ProxyByteListIterator

public interface ByteListIterator

extends ByteIterator

A bi-directional iterator over byte values.

Since:

Commons Collections 2.2

Version:

$Revision: 1.1 $ $Date: 2003/10/13 22:46:51 $

See Also:

ByteListIteratorListIterator, ListIteratorByteListIterator

Method Summary

void	add(byte element) Inserts the specified element into my underlying collection (optional operation).
boolean	hasNext() Returns true iff I have more elements when traversed in the forward direction.
boolean	hasPrevious() Returns true iff I have more elements when traversed in the reverse direction.
byte	next() Returns the next element in me when traversed in the forward direction.
int	nextIndex() Returns the index of the element that would be returned by a subsequent call to next(), or the number of elements in my iteration if I have no next element.
byte	previous() Returns the next element in me when traversed in the reverse direction.
int	previousIndex() Returns the index of the element that would be returned by a subsequent call to previous(), or -1 if I have no previous element.
void	remove() Removes from my underlying collection the last element returned by next() or previous() (optional operation).
void	set(byte element) Replaces in my underlying collection the last element returned by next() or previous() with the specified value (optional operation).

Method Detail

add

public void add(byte element)

Inserts the specified element into my underlying collection (optional operation). The element is inserted immediately before the next element that would have been returned by next(), if any, and immediately after the next element that would have been returned by previous(), if any.

The new element is inserted immediately before the implied cursor. A subsequent call to previous() will return the added element, a subsequent call to next() will be unaffected. This call increases by one the value that would be returned by a call to nextIndex() or previousIndex().

Parameters:

element - the value to be inserted

Throws:

UnsupportedOperationException - when this operation is not supported

IllegalArgumentException - if some aspect of the specified element prevents it from being added

hasNext

public boolean hasNext()

Returns true iff I have more elements when traversed in the forward direction. (In other words, returns true iff a call to next() will return an element rather than throwing an exception.

Specified by:

hasNext in interface ByteIterator

Returns:

true iff I have more elements when traversed in the forward direction

hasPrevious

public boolean hasPrevious()

Returns true iff I have more elements when traversed in the reverse direction. (In other words, returns true iff a call to previous() will return an element rather than throwing an exception.

Returns:

true iff I have more elements when traversed in the reverse direction

next

public byte next()

Returns the next element in me when traversed in the forward direction.

Specified by:

next in interface ByteIterator

Returns:

the next element in me

Throws:

NoSuchElementException - if there is no next element

nextIndex

public int nextIndex()

Returns the index of the element that would be returned by a subsequent call to next(), or the number of elements in my iteration if I have no next element.

Returns:

the index of the next element in me

previous

public byte previous()

Returns the next element in me when traversed in the reverse direction.

Returns:

the previous element in me

Throws:

NoSuchElementException - if there is no previous element

previousIndex

public int previousIndex()

Returns the index of the element that would be returned by a subsequent call to previous(), or -1 if I have no previous element.

Returns:

the index of the previous element in me

remove

public void remove()

Removes from my underlying collection the last element returned by next() or previous() (optional operation).

Specified by:

remove in interface ByteIterator

Throws:

UnsupportedOperationException - if this operation is not supported

IllegalStateException - if neither next() nor previous() has yet been called, or remove() or add(byte) has already been called since the last call to next() or previous().

set

public void set(byte element)

Replaces in my underlying collection the last element returned by next() or previous() with the specified value (optional operation).

Parameters:

element - the value to replace the last returned element with

Throws:

UnsupportedOperationException - if this operation is not supported

IllegalStateException - if neither next() nor previous() has yet been called, or remove() or add(byte) has already been called since the last call to next() or previous().

IllegalArgumentException - if some aspect of the specified element prevents it from being added