All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class COM.objectspace.jgl.ByteIterator

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

public final class ByteIterator
extends Object
implements RandomAccessIterator, Serializable

An ByteIterator is a random access iterator that allows you to iterate through an array of bytes.

See Also:: RandomAccessIterator

ByteIterator(): Construct myself to be an iterator with no associated data structure or position.
ByteIterator(byte[]): Construct myself to be an iterator positioned at the first element of a specified array.
ByteIterator(byte[], ByteArray): Construct myself to be an iterator positioned at the first element of a specified array.
ByteIterator(byte[], int): Construct myself to be positioned at a particular index of a specific array.
ByteIterator(byte[], int, ByteArray): Construct myself to be positioned at a particular index of a specific array.
ByteIterator(ByteIterator): 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(byte[]): Return an iterator positioned at the first element of a particular array.
begin(byte[], ByteArray): 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(byte[]): Return an iterator positioned immediately after the last element of a particular array.
end(byte[], ByteArray): Return an iterator positioned immediately after the last element of a particular array.
equals(ByteIterator): Return true if iterator is positioned at the same element as me.
equals(Object): Return true if a specified object is the same kind of iterator as me and is positioned at the same element.
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 container.
hasMoreElements(): Return true if there are more elements in my input stream.
index(): Return my current index.
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.

ByteIterator

  public ByteIterator()

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

ByteIterator

  public ByteIterator(ByteIterator iterator)

Construct myself to be a copy of an existing iterator.

Parameters:: iterator - The iterator to copy.

ByteIterator

  public ByteIterator(byte 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.

ByteIterator

  public ByteIterator(byte array[],
                      ByteArray byteArray)

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.; byteArray - The container this iterator is associated with.

ByteIterator

  public ByteIterator(byte 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.

ByteIterator

  public ByteIterator(byte array[],
                      int index,
                      ByteArray byteArray)

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

Parameters:: array - My associated array.; index - My associated index.; byteArray - The container this iterator is associated with.

begin

  public static ByteIterator begin(byte 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.

begin

  public static ByteIterator begin(byte array[],
                                   ByteArray byteArray)

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

Parameters:: array - The array whose first element I will be positioned at.; byteArray - The container this iterator is associated with.

end

  public static ByteIterator end(byte 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.

end

  public static ByteIterator end(byte array[],
                                 ByteArray byteArray)

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.; byteArray - The container this iterator is associated with.

clone

  public Object clone()

Return a clone of myself.

Overrides:: clone in class Object

index

  public int index()

Return my current index.

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

equals

  public boolean equals(ByteIterator iterator)

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

Parameters:: iterator - The iterator to compare myself against.

less

  public boolean less(RandomAccessIterator iterator)

Return true if I'm before a specified iterator.

Parameters:: iterator - The iterator to compare myself against.

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.

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.

atBegin

  public boolean atBegin()

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

atEnd

  public boolean atEnd()

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

hasMoreElements

  public boolean hasMoreElements()

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

advance

  public void advance()

Advance by one.

advance

  public void advance(int n)

Advance by a specified amount.

Parameters:: n - The amount to advance.

retreat

  public void retreat()

Retreat by one.

retreat

  public void retreat(int n)

Retreat by a specified amount.

Parameters:: n - The amount to retreat.

nextElement

  public Object nextElement()

Return the next element in my input stream.

get

  public Object get()

Return the object at my current position.

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.

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.

getContainer

  public Container getContainer()

Return my associated container.

All Packages  Class Hierarchy  This Package  Previous  Next  Index