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

## woolpack.utils
クラス Utils

    java.lang.Object
      woolpack.utils.Utils

    public final class Utils

extends java.lang.Object

ユーティリティです。 型推論で表記を簡略するためのスタティックメソッドを含みます。

作成者:
  nakamura

フィールドの概要
`static java.util.Set<java.lang.Class>` | `ATOM_SET` 値の個数に関して原子的であるクラスの一覧のデフォルト値です。

メソッドの概要
`static
`<K,V> java.util.concurrent.ConcurrentMap<K,V>`
` | `concurrentMap(java.util.Map<K,V> map, java.lang.Object lock)` `ConcurrentMap`で定義しているメソッドのみを lock で同期化する`ConcurrentMap`を返します。
`static
`<K,V> java.util.Map<K,V>`
` | `injectiveMap(java.util.Map<K,V> map)` 単射であることを維持する`Map`を返します。
`static
`<K,V> java.util.Map<V,K>`
` | `inverseMap(java.util.Map<K,V> before)` 逆写像の`Map`を返します。
`static
`<V> java.util.Map<java.lang.String,V>`
` | `keyNotEmptyMap(java.util.Map<java.lang.String,V> map)` キーの文字数がゼロであることを禁止する`Map`を返します。
`static
`<K,V> BuildableLinkedHashMap<K,V>`
` | `linkedMap(K key, V value)` Javaの汎用型の推論を使用して`LinkedHashMap`を簡易に生成するための開始位置です。
`static
`<V> BuildableArrayList<V>`
` | `list(V v)` Javaの汎用型の推論を使用して`List`を簡易に生成するための開始位置です。
`static
`<K,V> BuildableHashMap<K,V>`
` | `map(K key, V value)` Javaの汎用型の推論を使用して`Map`を簡易に生成するための開始位置です。
`static
`<K,V> java.util.Map<K,V>`
` | `notNullMap(java.util.Map<K,V> map)` キー・値が null 値をとることを禁止する`Map`を返します。
`static
`<V> java.util.Map<java.lang.String,V>`
` | `similarKeyMap(java.util.Map<java.lang.String,V> map)` 類似の名前を同一とみなす`Map`を返します。
`static java.util.Collection` | `toCollection(java.lang.Object value)` オブジェクトを`Collection`に変換します。
`static java.lang.Iterable` | `toIterable(java.lang.Object value)` オブジェクトを`Iterable`に変換します。
`static java.util.List` | `toList(java.lang.Object value)` オブジェクトを`List`に変換します。
`static java.util.List<java.lang.String>` | `toMessageList(java.lang.Throwable throwable)` `Throwable.getCause()`をたどって `Throwable.getLocalizedMessage()`の一覧に変換します。
`static
`<E> java.lang.Iterable<E>`
` | `unmodifiableIterable(java.lang.Iterable<E> iterable)` 変更禁止の`Iterable`を返します。
`static
`<K,V> java.util.Map<K,V>`
` | `unoverwritableMap(java.util.Map<K,V> map)` キーに関して上書き禁止した`Map`を返します。

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

フィールドの詳細

### ATOM_SET

    public static final java.util.Set<java.lang.Class> ATOM_SET

  値の個数に関して原子的であるクラスの一覧のデフォルト値です。処理の原子性とは無関係です。

メソッドの詳細

### inverseMap

    public static <K,V> java.util.Map<V,K> inverseMap(java.util.Map<K,V> before)

  逆写像の`Map`を返します。 引数が単射でなくなるキーと値の組を設定した場合は `IllegalStateException`を投げます。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `before` - 逆写像の作成元。本メソッドはこの引数の状態を変化させません。
  戻り値:
    逆写像の`Map`。返却値の状態変化と引数の状態変化は相互に伝播します。
  例外:
    `java.lang.IllegalStateException` - 引数が単射でない場合。

### injectiveMap

    public static <K,V> java.util.Map<K,V> injectiveMap(java.util.Map<K,V> map)

  単射であることを維持する`Map`を返します。 単射とは「map#keySet()に含まれるすべての k0 と k1 について k0 != k1 ならば map#get(k0) != map#get(k1)」 であることを意味します。 または対偶をとって 「map#keySet()に含まれるすべての k0 と k1 について map#get(k0) == map#get(k1) ならば k0 == k1」 であることを意味します。 登録済の値を異なるキーで設定した場合は `IllegalStateException`を投げます。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `map` - 単射であることを維持する対象の`Map`。本メソッドはこの引数の状態を変化させません。
  戻り値:
    単射であることを維持された`Map`。返却値の状態変化と引数の状態変化は相互に伝播します。

### unoverwritableMap

    public static <K,V> java.util.Map<K,V> unoverwritableMap(java.util.Map<K,V> map)

  キーに関して上書き禁止した`Map`を返します。 登録済のキーを設定した場合は`IllegalStateException`を投げます。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `map` - キーに関して上書き禁止する対象の`Map`。本メソッドはこの引数の状態を変化させません。
  戻り値:
    キーに関して上書き禁止された`Map`。返却値の状態変化と引数の状態変化は相互に伝播します。

### notNullMap

    public static <K,V> java.util.Map<K,V> notNullMap(java.util.Map<K,V> map)

  キー・値が null 値をとることを禁止する`Map`を返します。 キーまたは値が null 値である組を設定した場合は`NullPointerException`を投げます。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `map` - キー・値がnull値をとることを禁止する対象の`Map`。本メソッドはこの引数の状態を変化させません。
  戻り値:
    キー・値がnull値をとることを禁止された`Map`。返却値の状態変化と引数の状態変化は相互に伝播します。

### keyNotEmptyMap

    public static <V> java.util.Map<java.lang.String,V> keyNotEmptyMap(java.util.Map<java.lang.String,V> map)

  キーの文字数がゼロであることを禁止する`Map`を返します。 文字数がゼロのキーを設定した場合は `StringIndexOutOfBoundsException`を投げます。

  型パラメータ:
    `V` - 値。
  パラメータ:
    `map` - キーの文字数がゼロであることを禁止する対象の`Map`。本メソッドはこの引数の状態を変化させます。
  戻り値:
    キーの文字数がゼロであることを禁止された`Map`。返却値の状態変化と引数の状態変化は相互に伝播します。

### similarKeyMap

    public static <V> java.util.Map<java.lang.String,V> similarKeyMap(java.util.Map<java.lang.String,V> map)

  類似の名前を同一とみなす`Map`を返します。 類似の名前とは、大文字区切り(先頭文字の大文字と小文字の区別なし)と アンダーバー区切り(大文字と小文字の区別なし)の相互変換の範囲とします。

  型パラメータ:
    `V` - 値。
  パラメータ:
    `map` - 類似の名前を同一とみなす対象の`Map`。本メソッドはこの引数の状態を変化させません。
  戻り値:
    類似の名前を同一とみなす`Map`。返却値の状態変化と引数の状態変化は相互に伝播します。

### concurrentMap

    public static <K,V> java.util.concurrent.ConcurrentMap<K,V> concurrentMap(java.util.Map<K,V> map,
                                                                              java.lang.Object lock)

  `ConcurrentMap`で定義しているメソッドのみを lock で同期化する`ConcurrentMap`を返します。 DCLP(Double checked locking)パターンを使用しているためインスタンスが複数生成されることを抑止することはできませんが、 ひとつのインスタンスのみが複数のスレッドから参照されることを保証することができます。 `Map`で定義されているメソッドは同期化しないので引数の map が同期化されている必要があります。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `map` - 対象の`Map`。本メソッドはこの引数の状態を変化させません。
    `lock` - ロックオブジェクト。
  戻り値:
    ロックオブジェクトで原子化した`ConcurrentMap`。返却値の状態変化と引数の状態変化は相互に伝播します。

### unmodifiableIterable

    public static <E> java.lang.Iterable<E> unmodifiableIterable(java.lang.Iterable<E> iterable)

  変更禁止の`Iterable`を返します。

  型パラメータ:
    `E` - 汎用型。
  パラメータ:
    `iterable` - 変更禁止対象の`Iterable`。本メソッドはこの引数の状態を変化させません。
  戻り値:
    変更禁止された`Iterable`。引数の状態変化はこの返却値に伝播します。

### toIterable

    public static java.lang.Iterable toIterable(java.lang.Object value)

  オブジェクトを`Iterable`に変換します。 変換元が配列なら`Iterable`に変換します。 変換元が`Iterable`ならそのまま返します。 上記以外ならその値ひとつの`Iterable`を返します。 このクラスは LSP(The Liskov Substitution Principle) を満たしません。

  パラメータ:
    `value` - 変換元。
  戻り値:
    変換された`Iterable`。 変換元が配列または`Iterable` の場合は返却値の状態変化と引数の状態変化は相互に伝播します。

### toCollection

    public static java.util.Collection toCollection(java.lang.Object value)

  オブジェクトを`Collection`に変換します。 変換元が配列なら`Collection`に変換します。 変換元が`Collection`ならそのまま返します。 上記以外ならその値ひとつの`Collection`を返します。 このクラスは LSP(The Liskov Substitution Principle) を満たしません。

  パラメータ:
    `value` - 変換元。
  戻り値:
    変換された`Collection`。 変換元が配列または`Collection` の場合は返却値の状態変化と引数の状態変化は相互に伝播します。

### toList

    public static java.util.List toList(java.lang.Object value)

  オブジェクトを`List`に変換します。 変換元が配列なら`List`に変換します。 変換元が`List`ならそのまま返します。 上記以外ならその値ひとつの`List`を返します。 このクラスは LSP(The Liskov Substitution Principle) を満たしません。

  パラメータ:
    `value` - 変換元。
  戻り値:
    変換された`List`。変換元が配列または `List`の場合は返却値の状態変化と引数の状態変化は相互に伝播します。

### toMessageList

    public static java.util.List<java.lang.String> toMessageList(java.lang.Throwable throwable)

  `Throwable.getCause()`をたどって `Throwable.getLocalizedMessage()`の一覧に変換します。 中間の`Throwable`の場合、 メッセージが null でないかつメッセージが原因の `Throwable.toString()`と同一でない場合にメッセージとして追加します。 終端の`Throwable`の場合、 メッセージが null の場合は`Throwable.toString()`をメッセージとして追加し、 メッセージが null でない場合はそれをメッセージとして追加します。

  パラメータ:
    `throwable` - 基点。
  戻り値:
    メッセージの一覧。

### list

    public static <V> BuildableArrayList<V> list(V v)

  Javaの汎用型の推論を使用して`List`を簡易に生成するための開始位置です。

  型パラメータ:
    `V` -
  パラメータ:
    `v` - 追加する値。
  戻り値:
    `BuildableArrayList`のインスタンス。

### map

    public static <K,V> BuildableHashMap<K,V> map(K key,
                                                  V value)

  Javaの汎用型の推論を使用して`Map`を簡易に生成するための開始位置です。

  型パラメータ:
    `K` -
    `V` -
  パラメータ:
    `key` - 追加するキー。
    `value` - 追加するキーに対応する値。
  戻り値:
    `BuildableHashMap`のインスタンス。

### linkedMap

    public static <K,V> BuildableLinkedHashMap<K,V> linkedMap(K key,
                                                              V value)

  Javaの汎用型の推論を使用して`LinkedHashMap`を簡易に生成するための開始位置です。

  型パラメータ:
    `K` -
    `V` -
  パラメータ:
    `key` - 追加するキー。
    `value` - 追加するキーに対応する値。
  戻り値:
    `BuildableHashMap`のインスタンス。

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

Copyright (C) 2006-2007 Takahiro Nakamura. All rights reserved.