shohaku.core.collections
インタフェース KayValueIterator

すべてのスーパーインタフェース:
java.util.Iterator

public interface KayValueIterator
extends java.util.Iterator

キーと値の対とするデータ構造の反復子を提供します。
キーと値を対とするデータ構造を持つ複数の実装に対して、統一されたインターフェースからのアクセスを実現します。


メソッドの概要
 java.lang.Object getKey()
          キーを返却します。
 java.lang.Object getValue()
          値を返却します。
 java.lang.Object next()
          次の要素に移動しそのキーを返却します。
 void remove()
          このインターフェースは削除オペレーションを提供しません。
 java.lang.Object setValue(java.lang.Object value)
          値を変更して既存の値を返却します(任意オペレーション)。
 int size()
          要素数を返却します。
 
インタフェース java.util.Iterator から継承したメソッド
hasNext
 

メソッドの詳細

next

public java.lang.Object next()
次の要素に移動しそのキーを返却します。

定義:
インタフェース java.util.Iterator 内の next
戻り値:
次の要素のキー
例外:
java.util.NoSuchElementException - 次の要素が存在しない場合

remove

public void remove()
このインターフェースは削除オペレーションを提供しません。
実装クラスは必ずUnsupportedOperationExceptionを発生させてください。

定義:
インタフェース java.util.Iterator 内の remove
関連項目:
Iterator.remove()

getKey

public java.lang.Object getKey()
キーを返却します。
next()が呼び出された後で利用可能です、複数回に同一の要素にアクセス出来ます。

戻り値:
キー
例外:
java.util.NoSuchElementException - 次の要素が存在しない場合
java.lang.IllegalStateException - next()の呼出が行われていない場合

getValue

public java.lang.Object getValue()
値を返却します。
next()が呼び出された後で利用可能です、複数回に同一の要素にアクセス出来ます。

戻り値:
例外:
java.util.NoSuchElementException - 次の要素が存在しない場合
java.lang.IllegalStateException - next()の呼出が行われていない場合

setValue

public java.lang.Object setValue(java.lang.Object value)
値を変更して既存の値を返却します(任意オペレーション)。
next()が呼び出された後で利用可能です、複数回に同一の要素にアクセス出来ます。

パラメータ:
value - 値
戻り値:
既存の値
例外:
java.util.NoSuchElementException - 次の要素が存在しない場合
java.lang.IllegalStateException - next()の呼出が行われていない場合
java.lang.UnsupportedOperationException - このオペレーションをサポートしない場合

size

public int size()
要素数を返却します。

戻り値:
要素数