Packagecom.bourre.collection
Interfacepublic interface ListIterator extends Iterator
ImplementorsArrayIterator, StringIterator

Player version: Flash Player 9.0
Language version: ActionScript 3.0

An iterator for lists that allows the programmer to traverse the list in either direction, modify the list during iteration, and obtain the iterator's current position in the list. A ListIteratorprevious() and the element that would be returned by a call to next(). In a list of length n, there are n+1 valid index values, from 0 to n, inclusive.

Note that the remove() and set(Object) methods are not defined in terms of the cursor position; they are defined to operate on the last element returned by a call to next() or previous().

See also

Iterator.html


Public Methods
 MethodDefined by
  
add(o:Object):void
Inserts the specified element into the list (optional operation).
ListIterator
 Inherited
hasNext():Boolean
Returns true if the iteration has more elements.
Iterator
  
hasPrevious():Boolean
Returns true if this list iterator has more elements when traversing the list in the reverse direction.
ListIterator
 Inherited
next():*
Returns the next element in the iteration.
Iterator
  
nextIndex():uint
Returns the index of the element that would be returned by a subsequent call to next.
ListIterator
  
Returns the previous element in the list.
ListIterator
  
Returns the index of the element that would be returned by a subsequent call to previous.
ListIterator
 Inherited
remove():void
Removes from the underlying collection the last element returned by the iterator (optional operation).
Iterator
  
set(o:Object):void
Replaces the last element returned by next or previous with the specified element (optional operation).
ListIterator
Method detail
add()method
public function add(o:Object):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Inserts the specified element into the list (optional operation). The element is inserted immediately before the next element that would be returned by next, if any, and after the next element that would be returned by previous, if any. (If the list contains no elements, the new element becomes the sole element on the list.) The new element is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)

Parameters
o:Object — the element to insert.

Throws
UnsupportedOperationException — if the set operation is not supported by this list iterator.
 
ClassCastException — if the class of the specified element prevents it from being added to this list.
 
IllegalArgumentException — if some aspect of the specified element prevents it from being added to this list.
 
IllegalStateException — if neither next nor previous have been called, or remove or add have been called after the last call to next or previous.
hasPrevious()method 
public function hasPrevious():Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns true if this list iterator has more elements when traversing the list in the reverse direction. (In other words, returns true if previous would return an element rather than throwing an exception.)

Returns
Booleantrue if the list iterator has more elements when traversing the list in the reverse direction.
nextIndex()method 
public function nextIndex():uint

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the index of the element that would be returned by a subsequent call to next. (Returns list size if the list iterator is at the end of the list.)

Returns
uint — the index of the element that would be returned by a subsequent call to next, or list size if list iterator is at end of list.
previous()method 
public function previous():*

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the previous element in the list. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to next to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)

Returns
* — the previous element in the list.

Throws
NoSuchElementException — if the iteration has no previous element.
previousIndex()method 
public function previousIndex():uint

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns the index of the element that would be returned by a subsequent call to previous. (Returns -1 if the list iterator is at the beginning of the list.)

Returns
uint — the index of the element that would be returned by a subsequent call to previous, or -1 if list iterator is at beginning of list.
set()method 
public function set(o:Object):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Replaces the last element returned by next or previous with the specified element (optional operation). This call can be made only if neither ListIterator.remove nor ListIterator.add have been called after the last call to next or previous.

Parameters
o:Object — the element with which to replace the last element returned by next or previous.

Throws
UnsupportedOperationException — if the set operation is not supported by this list iterator.
 
ClassCastException — if the class of the specified element prevents it from being added to this list.
 
IllegalArgumentException — if some aspect of the specified element prevents it from being added to this list.
 
IllegalStateException — if neither next nor previous have been called, or remove or add have been called after the last call to next or previous.