org.apache.commons.collections.primitives.decorators
Class UnmodifiableShortListIterator

java.lang.Object
  extended byorg.apache.commons.collections.primitives.decorators.ProxyShortIterator
      extended byorg.apache.commons.collections.primitives.decorators.ProxyShortListIterator
          extended byorg.apache.commons.collections.primitives.decorators.UnmodifiableShortListIterator
All Implemented Interfaces:
ShortIterator, ShortListIterator

public final class UnmodifiableShortListIterator
extends org.apache.commons.collections.primitives.decorators.ProxyShortListIterator

Since:
Commons Primitives 1.0
Version:
$Revision: 1.1 $ $Date: 2003/10/29 18:57:15 $
Author:
Rodney Waldhoff

Method Summary
 void add(short value)
          Inserts the specified element into my underlying collection (optional operation).
protected  ShortIterator getIterator()
           
protected  ShortListIterator getListIterator()
           
 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.
 short 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 ProxyShortIterator.next(), or the number of elements in my iteration if I have no next element.
 short 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 ProxyShortListIterator.previous(), or -1 if I have no previous element.
 void remove()
          Removes from my underlying collection the last element returned by ProxyShortIterator.next() or ProxyShortListIterator.previous() (optional operation).
 void set(short value)
          Replaces in my underlying collection the last element returned by ProxyShortIterator.next() or ProxyShortListIterator.previous() with the specified value (optional operation).
static ShortListIterator wrap(ShortListIterator iterator)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.commons.collections.primitives.ShortListIterator
hasNext, next
 

Method Detail

remove

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


add

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

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

Parameters:
value - the value to be inserted

set

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

Parameters:
value - the value to replace the last returned element with

getListIterator

protected ShortListIterator getListIterator()

wrap

public static final ShortListIterator wrap(ShortListIterator iterator)

hasPrevious

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

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

nextIndex

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

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

previous

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

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

previousIndex

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

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

getIterator

protected final ShortIterator getIterator()

hasNext

public boolean hasNext()
Description copied from interface: ShortIterator
Returns true iff I have more elements. (In other words, returns true iff a subsequent call to next will return an element rather than throwing an exception.)

Specified by:
hasNext in interface ShortIterator
Returns:
true iff I have more elements

next

public short next()
Description copied from interface: ShortIterator
Returns the next element in me.

Specified by:
next in interface ShortIterator
Returns:
the next element in me


Copyright © 2002-2003 Apache Software Foundation. All Rights Reserved.