ObjectSpace Homepage

JGL - The Generic Collection Library for Java
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.objectspace.jgl.ForwardIterator

public interface ForwardIterator
extends InputIterator, OutputIterator
ForwardIterator is the interface of all iterators that can read and/or write one item at a time in a forward direction.

Method Index

o advance()
Advance by one.
o advance(int)
Advance by a specified amount.
o clone()
Return a clone of myself.
o distance(ForwardIterator)
Return the distance from myself to another iterator.
o get(int)
Return the object that is a specified distance from my current position.
o getContainer()
Return my associated container.
o put(int, Object)
Replace the object at a specified distance from my current position.

Methods

o advance 
 public abstract void advance()
Advance by one.

o advance 
 public abstract void advance(int n)
Advance by a specified amount.

Parameters:
n - The amount to advance.
o get 
 public abstract Object get(int offset)
Return the object that is a specified distance from my current position.

Parameters:
offset - The offset from my current position.
o put 
 public abstract void put(int offset,
                          Object object)
Replace the object at a specified distance from my current position.

Parameters:
offset - The offset from my current position.
object - The object to write.
o distance 
 public abstract int distance(ForwardIterator iterator)
Return the distance from myself to another iterator. I should be before the specified iterator.

Parameters:
iterator - The iterator to compare myself against.
o clone 
 public abstract Object clone()
Return a clone of myself.

Overrides:
clone in class Object
o getContainer 
 public abstract Container getContainer()
Return my associated container. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index