All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.OrderedSetIterator 

java.lang.Object
   |
   +----COM.objectspace.jgl.OrderedSetIterator
public final class OrderedSetIterator
extends Object
implements BidirectionalIterator
A OrderedSetIterator is a bidirectional iterator that allows you to iterate through the contents of a OrderedSet.

See Also:
BidirectionalIterator

Constructor Index

o OrderedSetIterator()
Construct myself to be an iterator with no associated data structure or position.
o OrderedSetIterator(OrderedSetIterator)
Construct myself to be a copy of an existing iterator.

Method Index

o advance()
Advance by one.
o advance(int)
Advance by a specified amount.
o atBegin()
Return true if I'm positioned at the first item of my input stream.
o atEnd()
Return true if I'm positioned after the last item in my input stream.
o clone()
Return a clone of myself.
o distance(ForwardIterator)
Return the distance from myself to another iterator.
o equals(Object)
Return true if a specified object is the same kind of iterator as me and is positioned at the same element.
o equals(OrderedSetIterator)
Return true if iterator is positioned at the same element as me.
o get()
Return the object at my current position.
o get(int)
Return the object that is a specified distance from my current position.
o getContainer()
Return my associated container.
o hasMoreElements()
Return true if there are more elements in my input stream.
o nextElement()
Return the next element in my input stream.
o put(int, Object)
Write an object at a specified distance from my current position.
o put(Object)
OrderedSet the object at my current position to a specified value.
o retreat()
Retreat by one.
o retreat(int)
Retreat by a specified amount.

Constructors

o OrderedSetIterator 
  public OrderedSetIterator()
Construct myself to be an iterator with no associated data structure or position.

o OrderedSetIterator 
  public OrderedSetIterator(OrderedSetIterator iterator)
Construct myself to be a copy of an existing iterator.

Parameters:
iterator - The iterator to copy.

Methods

o clone 
  public Object clone()
Return a clone of myself.

Overrides:
clone in class Object
o equals 
  public boolean equals(Object object)
Return true if a specified object is the same kind of iterator as me and is positioned at the same element.

Parameters:
object - Any object.
Overrides:
equals in class Object
o equals 
  public boolean equals(OrderedSetIterator iterator)
Return true if iterator is positioned at the same element as me.

Parameters:
iterator - The iterator to compare myself against.
o atBegin 
  public boolean atBegin()
Return true if I'm positioned at the first item of my input stream.

o atEnd 
  public boolean atEnd()
Return true if I'm positioned after the last item in my input stream.

o hasMoreElements 
  public boolean hasMoreElements()
Return true if there are more elements in my input stream.

o advance 
  public void advance()
Advance by one.

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

Parameters:
n - The amount to advance.
o retreat 
  public void retreat()
Retreat by one.

o retreat 
  public void retreat(int n)
Retreat by a specified amount.

Parameters:
n - The amount to retreat.
o nextElement 
  public Object nextElement()
Return the next element in my input stream.

o get 
  public Object get()
Return the object at my current position.

o put 
  public void put(Object object)
OrderedSet the object at my current position to a specified value.

Parameters:
object - The object to be written at my current position.
o get 
  public 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 void put(int offset,
                  Object object)
Write an 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 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 getContainer 
  public Container getContainer()
Return my associated container. 

All Packages  Class Hierarchy  This Package  Previous  Next  Index