All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.adapters.ObjectIterator

java.lang.Object
   |
   +----COM.objectspace.jgl.adapters.ObjectIterator

public final class ObjectIterator

extends Object

implements RandomAccessIterator, Serializable

See Also:

RandomAccessIterator

ObjectIterator()

Construct myself to be an iterator with no associated data structure or position.

ObjectIterator(Object[], int)

Construct myself to be positioned at a particular index of a specific array.

ObjectIterator(ObjectArray, int)

Construct myself to be positioned at a particular index of a specific array.

ObjectIterator(ObjectIterator)

Construct myself to be a copy of an existing iterator.

advance()

Advance by one.

advance(int)

Advance by a specified amount.

atBegin()

Return true if I'm positioned at the first item of my input stream.

atEnd()

Return true if I'm positioned after the last item in my input stream.

begin(Object[])

Return an iterator positioned at the first element of a particular array.

clone()

Return a clone of myself.

distance(ForwardIterator)

Return the distance from myself to another iterator.

end(Object[])

Return an iterator positioned immediately after the last element of a particular array.

equals(Object)

Return true if a specified object is the same kind of iterator as me and is positioned at the same element.

equals(ObjectIterator)

Return true if iterator is positioned at the same element as me.

get()

Return the object at my current position.

get(int)

Return the object that is a specified distance from my current position.

getContainer()

Return my associated array.

hasMoreElements()

Return true if there are more elements in my input stream.

index()

Return my current index.

isCompatibleWith(InputIterator)

Return true if both iterator and myself can be used as a range.

less(RandomAccessIterator)

Return true if I'm before a specified iterator.

nextElement()

Return the next element in my input stream.

put(int, Object)

Write an object at a specified distance from my current position.

put(Object)

Set the object at my current position to a specified value.

retreat()

Retreat by one.

retreat(int)

Retreat by a specified amount.

 public ObjectIterator()

Construct myself to be an iterator with no associated data structure or position.

 public ObjectIterator(ObjectIterator iterator)

Construct myself to be a copy of an existing iterator.

Parameters:

iterator - The iterator to copy.

 public ObjectIterator(Object array[],
                       int index)

Construct myself to be positioned at a particular index of a specific array.

Parameters:

array - My associated Object[].

index - My associated index.

 public ObjectIterator(ObjectArray array,
                       int index)

Construct myself to be positioned at a particular index of a specific array.

Parameters:

array - My associated ObjectArray.

index - My associated index.

 public static ObjectIterator begin(Object array[])

Return an iterator positioned at the first element of a particular array.

Parameters:

array - The array whose first element I will be positioned at.

 public static ObjectIterator end(Object array[])

Return an iterator positioned immediately after the last element of a particular array.

Parameters:

array - The array whose last element I will be positioned after.

 public Object clone()

Return a clone of myself.

Overrides:

clone in class Object

 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

 public boolean equals(ObjectIterator iterator)

Return true if iterator is positioned at the same element as me.

Parameters:

iterator - The iterator to compare myself against.

 public boolean less(RandomAccessIterator iterator)

Return true if I'm before a specified iterator.

Parameters:

iterator - The iterator to compare myself against.

 public boolean atBegin()

Return true if I'm positioned at the first item of my input stream.

 public boolean atEnd()

Return true if I'm positioned after the last item in my input stream.

 public boolean hasMoreElements()

Return true if there are more elements in my input stream.

 public void advance()

Advance by one.

 public void advance(int n)

Advance by a specified amount.

Parameters:

n - The amount to advance.

 public void retreat()

Retreat by one.

 public void retreat(int n)

Retreat by a specified amount.

Parameters:

n - The amount to retreat.

 public Object nextElement()

Return the next element in my input stream.

Throws: NoSuchElementException

If I'm positioned at an invalid index.

 public Object get()

Return the object at my current position.

Throws: ArrayIndexOutOfBoundsException

If I'm positioned at an invalid index.

 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.

Throws: ArrayIndexOutOfBoundsException

If the adjusted index is invalid.

 public void put(Object object)

Set the object at my current position to a specified value.

Parameters:

object - The object to be written at my current position.

Throws: ArrayIndexOutOfBoundsException

If I'm positioned at an invalid index.

 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.

Throws: ArrayIndexOutOfBoundsException

If the adjusted index is invalid.

 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.

Throws: IllegalArgumentException

If the iterators are incompatible.

 public int index()

Return my current index.

 public Container getContainer()

Return my associated array.

 public boolean isCompatibleWith(InputIterator iterator)

Return true if both iterator and myself can be used as a range.

All Packages  Class Hierarchy  This Package  Previous  Next  Index