decaf::util::ListIterator< E > Class Template Reference
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. More...
#include <src/main/decaf/util/ListIterator.h>
Public Member Functions | |
| virtual | ~ListIterator () |
| virtual void | add (const E &e)=0 |
| Inserts the specified element into the list (optional operation). | |
| virtual void | set (const E &e)=0 |
| Replaces the last element returned by next or previous with the specified element (optional operation). | |
| virtual bool | hasPrevious () const =0 |
| Returns true if this list iterator has more elements when traversing the list in the reverse direction. | |
| virtual E | previous ()=0 |
| Returns the previous element in the list. | |
| virtual int | nextIndex () const =0 |
| Returns the index of the element that would be returned by a subsequent call to next. | |
| virtual int | previousIndex () const =0 |
| Returns the index of the element that would be returned by a subsequent call to previous. | |
Detailed Description
template<typename E>
class decaf::util::ListIterator< E >
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.
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().
Constructor & Destructor Documentation
| virtual decaf::util::ListIterator< E >::~ListIterator | ( | ) | [inline, virtual] |
Member Function Documentation
| virtual void decaf::util::ListIterator< E >::add | ( | const E & | e | ) | [pure virtual] |
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:
-
e The element to insert into the List.
- Exceptions:
-
UnsupportedOperationException if the add method is not supported by this list iterator. IllegalArgumentException if some aspect of this element prevents it from being added to this list.
| virtual bool decaf::util::ListIterator< E >::hasPrevious | ( | ) | const [pure virtual] |
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:
- true if the list iterator has more elements when traversing the list in the reverse direction.
Implemented in decaf::util::concurrent::CopyOnWriteArrayList< E >::ArrayListIterator.
| virtual int decaf::util::ListIterator< E >::nextIndex | ( | ) | const [pure virtual] |
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:
- 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.
Implemented in decaf::util::concurrent::CopyOnWriteArrayList< E >::ArrayListIterator.
| virtual E decaf::util::ListIterator< E >::previous | ( | ) | [pure virtual] |
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.
- Exceptions:
-
NoSuchElementException if the iteration has no previous element.
Implemented in decaf::util::concurrent::CopyOnWriteArrayList< E >::ArrayListIterator.
| virtual int decaf::util::ListIterator< E >::previousIndex | ( | ) | const [pure virtual] |
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:
- 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.
Implemented in decaf::util::concurrent::CopyOnWriteArrayList< E >::ArrayListIterator.
| virtual void decaf::util::ListIterator< E >::set | ( | const E & | e | ) | [pure virtual] |
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:
-
e The element with which to replace the last element returned by next or previous.
- Exceptions:
-
UnsupportedOperationException if the add method is not supported by this list iterator. IllegalArgumentException if some aspect of this 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.
The documentation for this class was generated from the following file:
- src/main/decaf/util/ListIterator.h
