ObjectSpace Homepage

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

Class com.objectspace.jgl.HashMapIterator 

java.lang.Object
   |
   +----com.objectspace.jgl.HashMapIterator
public final class HashMapIterator
extends Object
implements ForwardIterator, Opaque
A HashMapIterator is a forward iterator that allows you to iterate through the contents of a HashMap. It has a mode that allows selection of the current position's key, value, or key-value pair.

See Also:
ForwardIterator

Variable Index

o KEY
o PAIR
o VALUE

Constructor Index

o HashMapIterator()
Construct myself to be an iterator with no associated data structure or position.
o HashMapIterator(HashMapIterator)
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 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 isCompatibleWith(InputIterator)
Return true if both iterator and myself can be used as a range.
o key()
Return the key of my current key/value pair.
o nextElement()
Return the next element in my input stream.
o opaqueData()
Should not be used directly.
o opaqueId()
Should not be used directly.
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 value()
Return the value of my current key/value pair.
o value(Object)
Change the value of my current key/value pair.

Variables

o PAIR 
 public static final int PAIR
o KEY 
 public static final int KEY
o VALUE 
 public static final int VALUE

Constructors

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

o HashMapIterator 
 public HashMapIterator(HashMapIterator 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 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.
Throws: InvalidOperationException
If the parameter is less than zero.
o nextElement 
 public Object nextElement()
Return the next element in my input stream.

Throws: NoSuchElementException
If I'm positioned at an invalid position.
o get 
 public Object get()
Return the object 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.
Throws: InvalidOperationException
If the parameter is less than zero.
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 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.
Throws: InvalidOperationException
If the parameter is less than zero.
o key 
 public Object key()
Return the key of my current key/value pair.

o value 
 public Object value()
Return the value of my current key/value pair.

o value 
 public void value(Object value)
Change the value of my current key/value pair.

Parameters:
object - The new value.
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.

o isCompatibleWith 
 public boolean isCompatibleWith(InputIterator iterator)
Return true if both iterator and myself can be used as a range.

o opaqueData 
 public Object opaqueData()
Should not be used directly.

See Also:
Opaque
o opaqueId 
 public int opaqueId()
Should not be used directly.

See Also:
Opaque 
All Packages  Class Hierarchy  This Package  Previous  Next  Index