com.uwyn.jhighlight.pcj.map

Interface CharKeyMapIterator

public interface CharKeyMapIterator

This interface represents iterators over maps from char values to objects.

Since:

1.0

Version:

1.0 2003/6/1

Author:

Søren Bak

See Also:

com.uwyn.rife.pcj.map.CharKeyMap, com.uwyn.rife.pcj.CharIterator

Method Summary

Modifier and Type	Method and Description
char	getKey() Returns the key of the current entry of this iterator.
Object	getValue() Returns the value of the current entry of this iterator.
boolean	hasNext() Indicates whether more entries can be returned by this iterator.
void	next() Advances to the next entry of this iterator.
void	remove() Removes the last entry value returned from the underlying map.

Method Detail

hasNext

boolean hasNext()

Indicates whether more entries can be returned by this iterator.

Returns:

true if more char entries can be returned by this iterator; returns false otherwise.

See Also:

next()

next

void next()

Advances to the next entry of this iterator.

Throws:

NoSuchElementException - if no more entries are available from this iterator.

See Also:

hasNext()

remove

void remove()

Removes the last entry value returned from the underlying map.

Throws:

UnsupportedOperationException - if removal is not supported by this iterator.

IllegalStateException - if no entry has been returned by this iterator yet.

getKey

char getKey()

Returns the key of the current entry of this iterator.

Returns:

the key of the current entry of this iterator.

Throws:

IllegalStateException - if there is no current entry (i.e. if next() has not been called or remove() has just been called.

See Also:

getValue()

getValue

Object getValue()

Returns the value of the current entry of this iterator.

Returns:

the value of the current entry of this iterator (which may be null).

Throws:

IllegalStateException - if there is no current entry (i.e. if next() has not been called or remove() has just been called.

See Also:

getKey()