概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## shohaku.core.collections.params
クラス ModifiableParameters

    java.lang.Object
      shohaku.core.collections.params.AbstractParameters
          shohaku.core.collections.params.AbstractModifiableParameters
              shohaku.core.collections.params.ModifiableParameters

すべての実装インタフェース:
  java.lang.Cloneable, java.io.Serializable

public final class ModifiableParameters
extends shohaku.core.collections.params.AbstractModifiableParameters
implements java.io.Serializable

媒介変数として名前と値のマッピングを格納し、要素の値を変更可能とするデータ構造を提供します。
このデータの要素は名前と値の対のデータ構造であり、また各要素は０から始まる順序を持ちます。
そのため要素へのアクセスは名前とインデックスをキーとする事ができます。
コンストラクタによる初期化以降には要素の値のみが変更可能となります。
このデータは名前と値の対のデータの双方向リンクリスト構造を持ちます。

関連項目:
  直列化された形式

入れ子クラスの概要
`static class` | `ModifiableParameters.Entry` `ModifiableParameters`のパラメータエントリを提供します。

コンストラクタの概要
`ModifiableParameters()` 空のパラメータリストを初期化します。
`ModifiableParameters(java.util.List nameValue)` 指定されたリストを名前と値を交互に持つデータとしてパラメータリストを初期化します。
`ModifiableParameters(java.util.Map prams)` 引数のマップのキーを名前として、そのキーの値を持つパラメータリストを初期化します。
`ModifiableParameters(ModifiableParameters prams)` 引数のパラメータリストと同エントリを持つパラメータリストを初期化します。
`ModifiableParameters(java.lang.Object[] nameValue)` 指定された配列を名前と値を交互に持つデータとしてパラメータリストを初期化します。

メソッドの概要
`java.lang.Object` | `clone()` クローンを生成して返却します。
`boolean` | `containsName(java.lang.String name)` 引数の名前のパラメータエントリが存在するか検証します。
`boolean` | `equals(java.lang.Object o)` 引数が同値であるか検証します。
`int` | `getIndex(java.lang.String name)` パラメータ名のインデックスを返却します。
`java.lang.String` | `getName(int index)` インデックスのパラメータ名を返却します。
`java.lang.Object` | `getValue(int index)` インデックスのパラメータ値を返却します、インデックスが存在しない場合は`null`が返されます。
`java.lang.Object` | `getValue(int index, java.lang.String defaultValue)` インデックスのパラメータ値を返却します、インデックスが存在しない場合は`defaultValue`が返されます。
`java.lang.Object` | `getValue(java.lang.String name)` パラメータ名のパラメータ値を返却します、名前が存在しない場合は`null`が返されます。
`java.lang.Object` | `getValue(java.lang.String name, java.lang.String defaultValue)` パラメータ名のパラメータ値を返却します、名前が存在しない場合は`defaultValue`が返されます。
`int` | `hashCode()` このオブジェクトのハッシュ値を返却します。
`boolean` | `isEmpty()` パラメータが空の場合`true`を返却します。
`boolean` | `isSingleton()` パラメータが一つのみの要素を持つ場合`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`

コンストラクタの詳細

### ModifiableParameters

    public ModifiableParameters()

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

### ModifiableParameters

    public ModifiableParameters(java.lang.Object[] nameValue)

  指定された配列を名前と値を交互に持つデータとしてパラメータリストを初期化します。

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

### ModifiableParameters

    public ModifiableParameters(java.util.List nameValue)

  指定されたリストを名前と値を交互に持つデータとしてパラメータリストを初期化します。

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

### ModifiableParameters

    public ModifiableParameters(java.util.Map prams)

  引数のマップのキーを名前として、そのキーの値を持つパラメータリストを初期化します。

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

### ModifiableParameters

    public ModifiableParameters(ModifiableParameters prams)

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

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

メソッドの詳細

### equals

    public boolean equals(java.lang.Object o)

  引数が同値であるか検証します。
  `ModifiableParameters`型でエントリが全て同一の場合のみ`true`を返却します。

  パラメータ:
    `o` - 比較先のオブジェクト
  戻り値:
    `ModifiableParameters`型でエントリが全て同一の場合のみ`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()`

### kayValueIterator

    public KayValueIterator kayValueIterator()

  引数リストの値の変更不可能かつ削除不可能な反復子を生成して返却します。

  戻り値:
    引数リストの値の変更不可能かつ削除不可能な反復子

### setValue

    public java.lang.Object setValue(java.lang.String name,
                                     java.lang.Object value)

  引数名の引数値を格納し、既存の引数値を返却します。
  指定された名前が存在しない場合は`IllegalIdentifierException`が発生します。

  パラメータ:
    `name` - 引数名
    `value` - 新たな引数値
  戻り値:
    既存の引数値
  例外:
    `IllegalIdentifierException` - 引数名が存在しない場合

### setValue

    public java.lang.Object setValue(int index,
                                     java.lang.Object value)

  インデックスの引数値を格納し、既存の引数値を返却します。
  指定されたインデックスが存在しない場合は`IllegalIdentifierException`が発生します。

  パラメータ:
    `index` - インデックス
    `value` - 新たな引数値
  戻り値:
    既存の引数値
  例外:
    `IllegalIdentifierException` - インデックスが存在しない場合

### size

    public int size()

  パラメータリストのエントリ数を返却します。

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

### iterator

    public java.util.Iterator iterator()

  パラメータリストの削除不可能な反復子を生成して返却します。
  反復子の要素は`AbstractParameters.AbstractEntry`型と為ります。

  戻り値:
    パラメータリストの削除不可能な反復子

### isEmpty

    public boolean isEmpty()

  パラメータが空の場合`true`を返却します。

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

### isSingleton

    public boolean isSingleton()

  パラメータが一つのみの要素を持つ場合`true`を返却します。

  戻り値:
    パラメータが一つのみの要素を持つ場合`true`

### getName

    public java.lang.String getName(int index)

  インデックスのパラメータ名を返却します。
  指定された名前が存在しない場合は`null`が返されます。

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

### getIndex

    public int getIndex(java.lang.String name)

  パラメータ名のインデックスを返却します。
  指定された名前が存在しない場合は`-1`が返されます。

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

### getValue

    public java.lang.Object getValue(java.lang.String name)

  パラメータ名のパラメータ値を返却します、名前が存在しない場合は`null`が返されます。

  パラメータ:
    `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)

  インデックスのパラメータ値を返却します、インデックスが存在しない場合は`null`が返されます。

  パラメータ:
    `index` - インデックス
  戻り値:
    指定されたインデックスのパラメータ値

### getValue

    public java.lang.Object getValue(int index,
                                     java.lang.String defaultValue)

  インデックスのパラメータ値を返却します、インデックスが存在しない場合は`defaultValue`が返されます。

  パラメータ:
    `index` - インデックス
    `defaultValue` - パラメータが存在しない場合に返却される値
  戻り値:
    指定されたインデックスのパラメータ値又は`defaultValue`

### containsName

    public boolean containsName(java.lang.String name)

  引数の名前のパラメータエントリが存在するか検証します。
  パラメータエントリが存在する場合のみ`true`を返却します。

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

### hashCode

    public int hashCode()

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

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

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド