All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.FloatIterator

java.lang.Object
   |
   +----COM.objectspace.jgl.FloatIterator

public final class FloatIterator
extends Object
implements RandomAccessIterator, Serializable
An FloatIterator is a random access iterator that allows you to iterate through an array of floats.

Version:
2.0.2
Author:
ObjectSpace, Inc.
See Also:
RandomAccessIterator

Constructor Index

 o FloatIterator()
Construct myself to be an iterator with no associated data structure or position.
 o FloatIterator(float[])
Construct myself to be an iterator positioned at the first element of a specified array.
 o FloatIterator(float[], FloatArray)
Construct myself to be an iterator positioned at the first element of a specified array.
 o FloatIterator(float[], int)
Construct myself to be positioned at a particular index of a specific array.
 o FloatIterator(float[], int, FloatArray)
Construct myself to be positioned at a particular index of a specific array.
 o FloatIterator(FloatIterator)
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 begin(float[])
Return an iterator positioned at the first element of a particular array.
 o begin(float[], FloatArray)
Return an iterator positioned at the first element of a particular array.
 o clone()
Return a clone of myself.
 o distance(ForwardIterator)
Return the distance from myself to another iterator.
 o end(float[])
Return an iterator positioned immediately after the last element of a particular array.
 o end(float[], FloatArray)
Return an iterator positioned immediately after the last element of a particular array.
 o equals(FloatIterator)
Return true if iterator is positioned at the same element as me.
 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 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 null for my associated Container since none needs to exist.
 o hasMoreElements()
Return true if there are more elements in my input stream.
 o index()
Return my current index.
 o less(RandomAccessIterator)
Return true if I'm before a specified iterator.
 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)
Set 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 FloatIterator
 public FloatIterator()
Construct myself to be an iterator with no associated data structure or position.

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

Parameters:
iterator - The iterator to copy.
 o FloatIterator
 public FloatIterator(float array[])
Construct myself to be an iterator positioned at the first element of a specified array.

Parameters:
array - The array whose first element I will be positioned at.
 o FloatIterator
 public FloatIterator(float array[],
                      FloatArray floatArray)
Construct myself to be an iterator positioned at the first element of a specified array.

Parameters:
array - The array whose first element I will be positioned at.
floatArray - The container the iterator is associated with.
 o FloatIterator
 public FloatIterator(float array[],
                      int index)
Construct myself to be positioned at a particular index of a specific array.

Parameters:
array - My associated array.
index - My associated index.
 o FloatIterator
 public FloatIterator(float array[],
                      int index,
                      FloatArray floatArray)
Construct myself to be positioned at a particular index of a specific array.

Parameters:
array - My associated array.
index - My associated index.
floatArray - The container the iterator is associated with.

Methods

 o begin
 public static FloatIterator begin(float 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.
 o begin
 public static FloatIterator begin(float array[],
                                   FloatArray floatArray)
Return an iterator positioned at the first element of a particular array.

Parameters:
array - The array whose first element I will be positioned at.
floatArray - The container the iterator is associated with.
 o end
 public static FloatIterator end(float 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.
 o end
 public static FloatIterator end(float array[],
                                 FloatArray floatArray)
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.
floatArray - The container the iterator is associated with.
 o clone
 public Object clone()
Return a clone of myself.

Overrides:
clone in class Object
 o index
 public int index()
Return my current index.

 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(FloatIterator iterator)
Return true if iterator is positioned at the same element as me.

Parameters:
iterator - The iterator to compare myself against.
 o less
 public boolean less(RandomAccessIterator iterator)
Return true if I'm before a specified iterator.

Parameters:
iterator - The iterator to compare myself against.
 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 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)
Set the object at my current position to a specified value.

Parameters:
object - The object to be written at my current position.
 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 null for my associated Container since none needs to exist.


All Packages  Class Hierarchy  This Package  Previous  Next  Index