shohaku.core.collections
クラス Parameters

java.lang.Object
  拡張shohaku.core.collections.Parameters
すべての実装インタフェース:
java.lang.Cloneable

public class Parameters
extends java.lang.Object
implements java.lang.Cloneable

媒介変数のマッピングを格納するデータ構造を定義します。
このデータは名前と値の対のデータの双方向リンクリスト構造を持ちます。


入れ子クラスの概要
static class Parameters.Entry
          パラメータのエントリを定義します。
 
フィールドの概要
static Parameters EMPTY_PARAMETERS
          空のパラメータリスト。
 
コンストラクタの概要
Parameters()
          空のパラメータリストを初期化します。
Parameters(KayValueIterator i)
          引数のキーと値の対とする反復子と同エントリを持つパラメータリストを初期化します。
Parameters(java.util.List nameValue)
          指定されたリストを名前と値を交互に持つデータとしてパラメータリストを初期化します。
Parameters(java.util.Map prams)
          引数のマップのキーを名前として、そのキーの値を持つパラメータリストを初期化します。
Parameters(java.lang.Object[] nameValue)
          指定された配列を名前と値を交互に持つデータとしてパラメータリストを初期化します。
Parameters(Parameters prams)
          引数のパラメータリストと同エントリを持つパラメータリストを初期化します。
Parameters(java.lang.String[] names)
          指定された名前と null の値でパラメータリストを初期化します。
 
メソッドの概要
 java.lang.Object clone()
          クローンを生成して返します。
 boolean containsName(java.lang.String name)
          引数の名前のパラメータエントリが存在するか検証します。
 boolean equals(java.lang.Object o)
          引数が同値であるか検証します。
 Parameters.Entry getEntry(int index)
          インデックスのエントリを返します。
 Parameters.Entry getEntry(java.lang.String name)
          パラメータ名のエントリを返します。
 int getIndex(java.lang.String name)
          パラメータ名のインデックスを返します。
 java.lang.String getName(int index)
          インデックスのパラメータ名を返します。
 java.lang.Object getValue(int index)
          インデックスのパラメータ値を返します。
 java.lang.Object getValue(java.lang.String name)
          パラメータ名のパラメータ値を返します。
 java.lang.Object getValue(java.lang.String name, java.lang.String defaultValue)
          パラメータ名のパラメータ値を返します。
 int hashCode()
          このオブジェクトのハッシュ値を返します。
 boolean isEmpty()
          パラメータが空の場合 true を返します。
 java.util.Iterator iterator()
          パラメータリストの反復子を生成して返します。
 KayValueIterator kayValueIterator()
          パラメータリストの反復子を生成して返します。
 java.lang.Object setValue(int index, java.lang.Object value)
          インデックスのパラメータ値を格納します。
 java.lang.Object setValue(java.lang.String name, java.lang.Object value)
          パラメータ名のパラメータ値を格納します。
 int size()
          パラメータリストのエントリ数を返します。
 java.lang.String toString()
          このオブジェクトの文字列表現を返します。
 
クラス java.lang.Object から継承したメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

EMPTY_PARAMETERS

public static final Parameters EMPTY_PARAMETERS
空のパラメータリスト。

コンストラクタの詳細

Parameters

public Parameters()
空のパラメータリストを初期化します。


Parameters

public Parameters(java.lang.String[] names)
指定された名前と null の値でパラメータリストを初期化します。

パラメータ:
names - パラメータ名

Parameters

public Parameters(java.lang.Object[] nameValue)
指定された配列を名前と値を交互に持つデータとしてパラメータリストを初期化します。

パラメータ:
nameValue - 名前と値を交互に持つ配列

Parameters

public Parameters(java.util.List nameValue)
指定されたリストを名前と値を交互に持つデータとしてパラメータリストを初期化します。

パラメータ:
nameValue - 名前と値を交互に持つリスト

Parameters

public Parameters(java.util.Map prams)
引数のマップのキーを名前として、そのキーの値を持つパラメータリストを初期化します。

パラメータ:
prams - 基となるマップ

Parameters

public Parameters(Parameters prams)
引数のパラメータリストと同エントリを持つパラメータリストを初期化します。

パラメータ:
prams - 基となるパラメータリスト

Parameters

public Parameters(KayValueIterator i)
引数のキーと値の対とする反復子と同エントリを持つパラメータリストを初期化します。

パラメータ:
i - 基となるパラメータリスト
メソッドの詳細

size

public int size()
パラメータリストのエントリ数を返します。

戻り値:
パラメータリストのエントリ数

iterator

public java.util.Iterator iterator()
パラメータリストの反復子を生成して返します。
反復子の要素は Parameters.Entry 型と為ります。

戻り値:
パラメータリストの反復子

kayValueIterator

public KayValueIterator kayValueIterator()
パラメータリストの反復子を生成して返します。
反復子の要素は Parameters.Entry 型と為ります。

戻り値:
パラメータリストの反復子

isEmpty

public boolean isEmpty()
パラメータが空の場合 true を返します。

戻り値:
パラメータが空の場合 true

getName

public java.lang.String getName(int index)
インデックスのパラメータ名を返します。

パラメータ:
index - インデックス
戻り値:
インデックスのパラメータ名

getIndex

public int getIndex(java.lang.String name)
パラメータ名のインデックスを返します。

パラメータ:
name - パラメータ名
戻り値:
パラメータ名のインデックス

getValue

public java.lang.Object getValue(java.lang.String name)
パラメータ名のパラメータ値を返します。

パラメータ:
name - パラメータ名
戻り値:
パラメータ値

getValue

public java.lang.Object getValue(java.lang.String name,
                                 java.lang.String defaultValue)
パラメータ名のパラメータ値を返します。
指定された名前が存在しない場合は、 defaultValue が返されます。

パラメータ:
name - パラメータ名
defaultValue - パラメータが存在しない場合に返却される値
戻り値:
指定された名前のパラメータ値又は defaultValue

getValue

public java.lang.Object getValue(int index)
インデックスのパラメータ値を返します。

パラメータ:
index - インデックス
戻り値:
インデックスのパラメータ値

setValue

public java.lang.Object setValue(java.lang.String name,
                                 java.lang.Object value)
パラメータ名のパラメータ値を格納します。
既存のパラメータ値が存在する場合その値を返し、存在しない場合 null を返します。

パラメータ:
name - パラメータ名
value - 新たなパラメータ値
戻り値:
既存のパラメータ値が存在する場合その値、存在しない場合 null

setValue

public java.lang.Object setValue(int index,
                                 java.lang.Object value)
インデックスのパラメータ値を格納します。
既存のパラメータ値が存在する場合その値を返し、存在しない場合 null を返します。

パラメータ:
index - インデックス
value - 新たなパラメータ値
戻り値:
既存のパラメータ値が存在する場合その値、存在しない場合 null

getEntry

public Parameters.Entry getEntry(java.lang.String name)
パラメータ名のエントリを返します。

パラメータ:
name - パラメータ名
戻り値:
パラメータ名のエントリ

getEntry

public Parameters.Entry getEntry(int index)
インデックスのエントリを返します。

パラメータ:
index - インデックス
戻り値:
インデックスのエントリ

containsName

public boolean containsName(java.lang.String name)
引数の名前のパラメータエントリが存在するか検証します。
パラメータエントリが存在する場合のみ true を返します。

パラメータ:
name - 検証する名前
戻り値:
パラメータエントリが存在する場合のみ true

hashCode

public int hashCode()
このオブジェクトのハッシュ値を返します。
全てのエントリのハッシュ値の合計です。

戻り値:
このオブジェクトのハッシュ値
関連項目:
Object.hashCode()

equals

public boolean equals(java.lang.Object o)
引数が同値であるか検証します。
Parameters 型でエントリが全て同一の場合のみ true を返します。

パラメータ:
o - 比較先のオブジェクト
戻り値:
Parameters 型でエントリが全て同一の場合のみ true
関連項目:
Object.equals(java.lang.Object)

toString

public java.lang.String toString()
このオブジェクトの文字列表現を返します。
{name=value, name=value, ...}

戻り値:
このオブジェクトの文字列表現
関連項目:
Object.toString()

clone

public java.lang.Object clone()
クローンを生成して返します。

戻り値:
このオブジェクトのクローン
関連項目:
Object.clone()