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

## shohaku.core.collections.group
クラス SingletonGroup

    java.lang.Object
      shohaku.core.collections.group.SingletonGroup

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

public class SingletonGroup
extends java.lang.Object
implements Group, java.io.Serializable

唯一のキーとコレクションをマッピングする不変のグループをを提供します。返されるグループは直列化可能です。

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

入れ子クラスの概要

クラス shohaku.core.collections.Group から継承した入れ子クラス
`Group.Entry`

コンストラクタの概要
`SingletonGroup(java.lang.Object key, java.util.Collection values)` 唯一のキーとコレクションの対を指定して初期化します。

メソッドの概要
`boolean` | `add(java.lang.Object key)` `UnsupportedOperationException`を発生させます。
`boolean` | `add(java.lang.Object key, java.lang.Object value)` `UnsupportedOperationException`を発生させます。
`void` | `addAll(Group g)` `UnsupportedOperationException`を発生させます。
`boolean` | `addAll(java.lang.Object key, java.util.Collection c)` `UnsupportedOperationException`を発生させます。
`void` | `clear()` `UnsupportedOperationException`を発生させます。
`boolean` | `containsKey(java.lang.Object key)` 指定されたキーのマッピングがグループに含まれている場合に`true`を返却します。
`boolean` | `containsValue(java.lang.Object key, java.lang.Object value)` グループが、キーのマッピングしているコレクションに指定された値を 1 つ以上含む場合に`true`を返却します。
`java.util.Set` | `entrySet()` 唯一のグループエントリを`Collections.singleton(Object o)`でラッピングした変更不可能なセットを返却します。
`boolean` | `equals(java.lang.Object o)` 指定されたオブジェクトがこのグループと等しいかどうかを比較します。
`java.util.Collection` | `get(java.lang.Object key)` 指定されたキーにマッピングされたコレクションを返却します。
`int` | `hashCode()` グループのハッシュコード値を返却します。
`boolean` | `isEmpty()` グループがキーとコレクションのマッピングを保持しない場合に`true`を返却します。
`java.util.Iterator` | `iterator()` グループに含まれるグループエントリの反復子を返却します。
`java.util.Iterator` | `iterator(java.lang.Object key)` 指定されたキーにマッピングされたコレクションの要素の反復子を返却します。
`java.util.Set` | `keySet()` 唯一のキーを`Collections.singleton(Object o)`でラッピングした変更不可能なセットを返却します。
`java.util.Collection` | `remove(java.lang.Object key)` `UnsupportedOperationException`を発生させます。
`boolean` | `remove(java.lang.Object key, java.lang.Object value)` `UnsupportedOperationException`を発生させます。
`int` | `size()` グループ内のキーと値の集合の数を返却します。
`int` | `size(java.lang.Object key)` グループ内のキーとマッピングする値のの要素数を返却します。
`java.lang.String` | `toString()`

クラス java.lang.Object から継承したメソッド
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

コンストラクタの詳細

### SingletonGroup

    public SingletonGroup(java.lang.Object key,
                          java.util.Collection values)

  唯一のキーとコレクションの対を指定して初期化します。

パラメータ:
  `key` - 返されるグループに格納されている唯一のキー
  `values` - 返されるグループによって key がマッピングされるコレクション

メソッドの詳細

### add

    public boolean add(java.lang.Object key)

  `UnsupportedOperationException`を発生させます。

  定義:
    インタフェース `Group` 内の `add`
  パラメータ:
    `key` - 指定されるコレクションが関連付けられるキー
  戻り値:
    既にこのキーに対するマッピングがある場合 true
  関連項目:
    `Group.add(java.lang.Object)`

### add

    public boolean add(java.lang.Object key,
                       java.lang.Object value)

  `UnsupportedOperationException`を発生させます。

  定義:
    インタフェース `Group` 内の `add`
  パラメータ:
    `key` - 指定される値が関連付けられるキー
    `value` - 指定されるキーに関連付けられる値
  戻り値:
    既にこのキーに対するマッピングがある場合 true
  関連項目:
    `Group.add(java.lang.Object, java.lang.Object)`

### addAll

    public void addAll(Group g)

  `UnsupportedOperationException`を発生させます。

  定義:
    インタフェース `Group` 内の `addAll`
  パラメータ:
    `g` - グループに追加されるグループ
  関連項目:
    `Group.addAll(shohaku.core.collections.Group)`

### addAll

    public boolean addAll(java.lang.Object key,
                          java.util.Collection c)

  `UnsupportedOperationException`を発生させます。

  定義:
    インタフェース `Group` 内の `addAll`
  パラメータ:
    `key` - 指定されるコレクションの全要素が関連付けられるキー
    `c` - 指定されるキーに関連付けられるコレクション
  戻り値:
    既にこのキーに対するマッピングがある場合 true
  関連項目:
    `Group.addAll(java.lang.Object, java.util.Collection)`

### remove

    public java.util.Collection remove(java.lang.Object key)

  `UnsupportedOperationException`を発生させます。

  定義:
    インタフェース `Group` 内の `remove`
  パラメータ:
    `key` - 関連づけられている識別キー
  戻り値:
    指定されたキーとマッピングされていた以前のコレクション。キーのマッピングがなかった場合は null
  関連項目:
    `Group.remove(java.lang.Object)`

### remove

    public boolean remove(java.lang.Object key,
                          java.lang.Object value)

  `UnsupportedOperationException`を発生させます。

  定義:
    インタフェース `Group` 内の `remove`
  パラメータ:
    `key` - 関連づけられている識別キー
    `value` -
  戻り値:
    指定されたキーと関連付けられていた以前のコレクション。キーのマッピングがなかった場合は null
  関連項目:
    `Group.remove(java.lang.Object, java.lang.Object)`

### clear

    public void clear()

  `UnsupportedOperationException`を発生させます。

  定義:
    インタフェース `Group` 内の `clear`
  関連項目:
    `Group.clear()`

### keySet

    public java.util.Set keySet()

  唯一のキーを`Collections.singleton(Object o)`でラッピングした変更不可能なセットを返却します。

  定義:
    インタフェース `Group` 内の `keySet`
  戻り値:
    グループに含まれているキーのセットビュー
  関連項目:
    `Group.keySet()`

### entrySet

    public java.util.Set entrySet()

  唯一のグループエントリを`Collections.singleton(Object o)`でラッピングした変更不可能なセットを返却します。

  定義:
    インタフェース `Group` 内の `entrySet`
  戻り値:
    グループに含まれているグループエントリのセットビュー
  関連項目:
    `Group.entrySet()`

### get

    public java.util.Collection get(java.lang.Object key)

  インタフェース `Group` の記述:

  指定されたキーにマッピングされたコレクションを返却します。
  グループがこのキーのマッピングを保持していない場合は`null`を返却します。

  戻り値に`Collection`の継承インターフェースの型が戻す実装も有り得ます。
  つまり左記の処理が有効である実装が有り得ます`List l = (List) group.get(key);`。

  定義:
    インタフェース `Group` 内の `get`
  パラメータ:
    `key` - 関連づけられている識別キー
  戻り値:
    指定のキーをマッピングするコレクション

### iterator

    public java.util.Iterator iterator()

  インタフェース `Group` の記述:
  グループに含まれるグループエントリの反復子を返却します。
  反復子の要素は Group.Entry 型に為ります。 エントリが存在しない場合空の反復子が返ります。

  定義:
    インタフェース `Group` 内の `iterator`
  戻り値:
    グループエントリの反復子

### iterator

    public java.util.Iterator iterator(java.lang.Object key)

  インタフェース `Group` の記述:
  指定されたキーにマッピングされたコレクションの要素の反復子を返却します。
  指定されたキーにマッピングされたコレクションが存在しない場合空の反復子が返ります。

  定義:
    インタフェース `Group` 内の `iterator`
  パラメータ:
    `key` - 関連づけられている識別キー
  戻り値:
    キーにマッピングされたコレクションの反復子

### isEmpty

    public boolean isEmpty()

  インタフェース `Group` の記述:
  グループがキーとコレクションのマッピングを保持しない場合に`true`を返却します。

  定義:
    インタフェース `Group` 内の `isEmpty`
  戻り値:
    グループがキーとコレクションのマッピングを保持しない場合は true

### containsKey

    public boolean containsKey(java.lang.Object key)

  インタフェース `Group` の記述:
  指定されたキーのマッピングがグループに含まれている場合に`true`を返却します。

  つまり、(k.equals(key)) という条件で、キー key のマッピングがグループに含まれる場合に`true`を返却します。
  グループはこのようなマッピングを 1 つだけ含むことができます。

  定義:
    インタフェース `Group` 内の `containsKey`
  パラメータ:
    `key` - マッピングされているか判定されるキー
  戻り値:
    グループが指定のキーのマッピングを保持する場合は true

### containsValue

    public boolean containsValue(java.lang.Object key,
                                 java.lang.Object value)

  インタフェース `Group` の記述:
  グループが、キーのマッピングしているコレクションに指定された値を 1 つ以上含む場合に`true`を返却します。

  つまり、(k.equals(key)) という条件で、キー key のマッピングがグループに含まれる場合、コレクション c に対して要素 value が (c.contains(value)) の条件で true の場合に true を返却します。

  定義:
    インタフェース `Group` 内の `containsValue`
  パラメータ:
    `key` - マッピングされているか判定されるキー
    `value` - キーをマッピングしているコレクションの内に存在するか判定される値
  戻り値:
    グループが指定のキーにマッピングされるコレクションの内に値が存在する場合は true

### size

    public int size()

  インタフェース `Group` の記述:
  グループ内のキーと値の集合の数を返却します。
  グループに Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返却します。

  定義:
    インタフェース `Group` 内の `size`
  戻り値:
    マッピングの数

### size

    public int size(java.lang.Object key)

  インタフェース `Group` の記述:
  グループ内のキーとマッピングする値のの要素数を返却します。
  この値に Integer.MAX_VALUE より多くの要素がある場合は、Integer.MAX_VALUE を返却します。

  定義:
    インタフェース `Group` 内の `size`
  パラメータ:
    `key` - キー
  戻り値:
    キーとマッピングする値のの要素数

### hashCode

    public int hashCode()

  インタフェース `Group` の記述:
  グループのハッシュコード値を返却します。

  グループのハッシュコードは、グループが保有する全てのグループエントリの hashCode の合計になるように定義されます。
  これにより、Object.hashCode の一般規約によって要求されるように、任意の 2 つのグループ t1 と t2 で t1.equals(t2) であれば、t1.hashCode()==t2.hashCode() となることが保証されます。

  定義:
    インタフェース `Group` 内の `hashCode`

### equals

    public boolean equals(java.lang.Object o)

  インタフェース `Group` の記述:
  指定されたオブジェクトがこのグループと等しいかどうかを比較します。

  指定されたオブジェクトもグループであり、2 つの Group が同じグループエントリを表している場合は true を返却します。
  つまり、t1.entrySet().equals(t2.entrySet()) である場合、2 つのグループ t1 と t2 は同じグループエントリを表します。
  これにより、Group インタフェースの実装が異なる場合でも、equals メソッドが正しく動作することが保証されます。

  定義:
    インタフェース `Group` 内の `equals`

### toString

    public java.lang.String toString()

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