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

## woolpack.utils
クラス UtilsConstants

    java.lang.Object
      woolpack.utils.UtilsConstants

    public class UtilsConstants

extends java.lang.Object

静的メソッドの集まり。

作成者:
  nakamura

メソッドの概要
`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> java.util.Map<K,V>`
` | `notNullMap(java.util.Map<K,V> map)` キー・値がnull値をとることを禁止する`Map`を返す。
`static
`<K,V> Switchable<K,V>`
` | `nullToDefaultSwitchIfAbsent(V defaultValue, Switchable<K,V> switchable)` 委譲先の`Switchable#get(K)`の返却値が null の場合、デフォルト値を設定した`Switchable`を返す。
`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()`をたどってエラーメッセージの一覧に変換する。
`static
`<T> java.lang.Iterable<T>`
` | `unmodifiableIterable(java.lang.Iterable<T> 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`

メソッドの詳細

### nullToDefaultSwitchIfAbsent

    public static <K,V> Switchable<K,V> nullToDefaultSwitchIfAbsent(V defaultValue,
                                                                    Switchable<K,V> switchable)

  委譲先の`Switchable#get(K)`の返却値が null の場合、デフォルト値を設定した`Switchable`を返す。 既に switchable にデフォルト値が定められている場合は引数の switchable を返す。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `defaultValue` - 委譲先の返却値が null の場合のデフォルト値。
    `switchable` - 委譲先。本メソッドはこの引数の状態を変化させない。
  戻り値:
    委譲先の`Switchable#get(K)`の返却値が null の場合、デフォルト値を設定し`Switchable`。
  例外:
    `java.lang.NullPointerException` - switchable が null の場合。

### inverseMap

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

  逆写像の`Map`を返す。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `before` - 逆写像の作成元。本メソッドはこの引数の状態を変化させない。
  戻り値:
    逆写像の`Map`。返却値の状態変化は引数の状態変化に影響しない。
  例外:
    `java.lang.NullPointerException` - 引数が null の場合。
    `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`。返却値の状態変化は引数の状態変化に影響する。
  例外:
    `java.lang.NullPointerException` - 引数が null の場合。

### unoverwritableMap

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

  オーバライド禁止の`Map`を返す。 登録済のキーを設定した場合は`IllegalStateException`を投げる。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `map` - オーバライドを禁止する対象の`Map`。本メソッドはこの引数の状態を変化させない。
  戻り値:
    オーバライドが禁止された`Map`。返却値の状態変化は引数の状態変化に影響する。
  例外:
    `java.lang.NullPointerException` - 引数が null の場合。

### notNullMap

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

  キー・値がnull値をとることを禁止する`Map`を返す。 登録済の値を設定した場合は`NullPointerException`を投げる。

  型パラメータ:
    `K` - キー。
    `V` - 値。
  パラメータ:
    `map` - キー・値がnull値をとることを禁止する対象の`Map`。本メソッドはこの引数の状態を変化させない。
  戻り値:
    キー・値がnull値をとることを禁止された`Map`。返却値の状態変化は引数の状態変化に影響する。
  例外:
    `java.lang.NullPointerException` - 引数が null の場合。

### 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`。返却値の状態変化は引数の状態変化に影響する。
  例外:
    `java.lang.NullPointerException` - 引数が null の場合。

### 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`。返却値の状態変化は引数の状態変化に影響する。
  例外:
    `java.lang.NullPointerException` - 引数が null の場合。

### 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`。返却値の状態変化は引数の状態変化に影響する。
  例外:
    `java.lang.NullPointerException` - 引数のいずれかが null の場合。

### unmodifiableIterable

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

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

  型パラメータ:
    `T` - 汎用型。
  パラメータ:
    `iterable` - 変更禁止対象の`Iterable`。本メソッドはこの引数の状態を変化させない。
  戻り値:
    変更禁止された`Iterable`。

### toIterable

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

  オブジェクトを`Iterable`に変換する。 変換元が配列なら`Iterable`に変換する。 変換元が`Iterable`ならそのまま返す。 上記以外ならその値ひとつの`Iterable`を返す。

  パラメータ:
    `value` - 変換元。
  戻り値:
    変換された`Iterable`。

### toCollection

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

  オブジェクトを`Collection`に変換する。 変換元が配列なら`Collection`に変換する。 変換元が`Collection`ならそのまま返す。 上記以外ならその値ひとつの`Collection`を返す。

  パラメータ:
    `value` - 変換元。
  戻り値:
    変換された`Collection`。

### toList

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

  オブジェクトを`List`に変換する。 変換元が配列なら`List`に変換する。 変換元が`List`ならそのまま返す。 上記以外ならその値ひとつの`List`を返す。

  パラメータ:
    `value` - 変換元。
  戻り値:
    変換された`List`。

### toMessageList

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

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

  パラメータ:
    `throwable` - 基点。
  戻り値:
    メッセージの一覧。
  例外:
    `java.lang.NullPointerException` - 引数が null の場合。

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