Package org.apache.sis.internal.util

Class AbstractMap.KeyIterator

java.lang.Object

org.apache.sis.internal.util.AbstractMap.EntryIterator<K,V>

org.apache.sis.internal.util.AbstractMap.KeyIterator

Enclosing class:

AbstractMap<K,V>

protected final class AbstractMap.KeyIterator
extends AbstractMap.EntryIterator<K,V>

Convenience EntryIterator implementation which iterates over a list of key candidates. All keys associated to a null value will be skipped.

Since:

0.8

See Also:

• AbstractMap.entryIterator()

Constructor Summary

Constructors

Constructor	Description
KeyIterator(K... keys)	Creates a new iterator over the given key candidates.

Method Summary

Modifier and Type	Method	Description
protected K	getKey()	Returns the key at the current iterator position.
protected V	getValue()	Returns the value at the current iterator position.
protected boolean	next()	Moves to the next key associated to a non-null value.

Methods inherited from class org.apache.sis.internal.util.AbstractMap.EntryIterator

getEntry, remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeyIterator

@SafeVarargs
public KeyIterator(K... keys)

Creates a new iterator over the given key candidates. The given array is not cloned; do not modify.

Parameters:

keys - all keys that the map may possibly contain.

Method Details

next

protected boolean next()

Moves to the next key associated to a non-null value.

Specified by:

next in class AbstractMap.EntryIterator<K,V>

Returns:

false if this method reached iteration end.

getKey

protected K getKey()

Description copied from class: AbstractMap.EntryIterator

Returns the key at the current iterator position. This method is invoked only after AbstractMap.EntryIterator.next().

Specified by:

getKey in class AbstractMap.EntryIterator<K,V>

Returns:

the key at the current iterator position.

getValue

protected V getValue()

Description copied from class: AbstractMap.EntryIterator

Returns the value at the current iterator position. This method is invoked only after AbstractMap.EntryIterator.next().

Specified by:

getValue in class AbstractMap.EntryIterator<K,V>

Returns:

the value at the current iterator position.