org.apache.commons.collections.primitives.adapters
Class ListIteratorByteListIterator

java.lang.Object
  extended by org.apache.commons.collections.primitives.adapters.ListIteratorByteListIterator
All Implemented Interfaces:
ByteIterator, ByteListIterator

public class ListIteratorByteListIterator
extends java.lang.Object
implements ByteListIterator

Adapts a Number-valued ListIterator to the ByteListIterator interface.

This implementation delegates most methods to the provided ByteListIterator implementation in the "obvious" way.

Since:
Commons Primitives 1.0
Version:
$Revision: 1.3 $ $Date: 2003/10/16 20:49:38 $
Author:
Rodney Waldhoff

Field Summary
private  java.util.ListIterator _iterator
           
 
Constructor Summary
ListIteratorByteListIterator(java.util.ListIterator iterator)
          Creates an ByteListIterator wrapping the specified ListIterator.
 
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 ByteListIterator.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 ByteListIterator.previous(), or -1 if I have no previous element.
 void remove()
          Removes from my underlying collection the last element returned by ByteListIterator.next() or ByteListIterator.previous() (optional operation).
 void set(byte element)
          Replaces in my underlying collection the last element returned by ByteListIterator.next() or ByteListIterator.previous() with the specified value (optional operation).
static ByteListIterator wrap(java.util.ListIterator iterator)
          Create an ByteListIterator wrapping the specified ListIterator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_iterator

private java.util.ListIterator _iterator
Constructor Detail

ListIteratorByteListIterator

public ListIteratorByteListIterator(java.util.ListIterator iterator)
Creates an ByteListIterator wrapping the specified ListIterator.

See Also:
wrap(java.util.ListIterator)
Method Detail

wrap

public static ByteListIterator wrap(java.util.ListIterator iterator)
Create an ByteListIterator wrapping the specified ListIterator. When the given iterator is null, returns null.

Parameters:
iterator - the (possibly null) ListIterator to wrap
Returns:
an ByteListIterator wrapping the given iterator, or null when iterator is null.

nextIndex

public int nextIndex()
Description copied from interface: ByteListIterator
Returns the index of the element that would be returned by a subsequent call to ByteListIterator.next(), or the number of elements in my iteration if I have no next element.

Specified by:
nextIndex in interface ByteListIterator
Returns:
the index of the next element in me

previousIndex

public int previousIndex()
Description copied from interface: ByteListIterator
Returns the index of the element that would be returned by a subsequent call to ByteListIterator.previous(), or -1 if I have no previous element.

Specified by:
previousIndex in interface ByteListIterator
Returns:
the index of the previous element in me

hasNext

public boolean hasNext()
Description copied from interface: ByteListIterator
Returns true iff I have more elements when traversed in the forward direction. (In other words, returns true iff a call to ByteListIterator.next() will return an element rather than throwing an exception.

Specified by:
hasNext in interface ByteIterator
Specified by:
hasNext in interface ByteListIterator
Returns:
true iff I have more elements when traversed in the forward direction

hasPrevious

public boolean hasPrevious()
Description copied from interface: ByteListIterator
Returns true iff I have more elements when traversed in the reverse direction. (In other words, returns true iff a call to ByteListIterator.previous() will return an element rather than throwing an exception.

Specified by:
hasPrevious in interface ByteListIterator
Returns:
true iff I have more elements when traversed in the reverse direction

next

public byte next()
Description copied from interface: ByteListIterator
Returns the next element in me when traversed in the forward direction.

Specified by:
next in interface ByteIterator
Specified by:
next in interface ByteListIterator
Returns:
the next element in me

previous

public byte previous()
Description copied from interface: ByteListIterator
Returns the next element in me when traversed in the reverse direction.

Specified by:
previous in interface ByteListIterator
Returns:
the previous element in me

add

public void add(byte element)
Description copied from interface: ByteListIterator
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 ByteListIterator.next(), if any, and immediately after the next element that would have been returned by ByteListIterator.previous(), if any.

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

Specified by:
add in interface ByteListIterator
Parameters:
element - the value to be inserted

set

public void set(byte element)
Description copied from interface: ByteListIterator
Replaces in my underlying collection the last element returned by ByteListIterator.next() or ByteListIterator.previous() with the specified value (optional operation).

Specified by:
set in interface ByteListIterator
Parameters:
element - the value to replace the last returned element with

remove

public void remove()
Description copied from interface: ByteListIterator
Removes from my underlying collection the last element returned by ByteListIterator.next() or ByteListIterator.previous() (optional operation).

Specified by:
remove in interface ByteIterator
Specified by:
remove in interface ByteListIterator


Copyright (c) 2002-2003 - Apache Software Foundation