Java8 の Optional 型を返す Generics を使ったメソッドを定義する

公開日： 2014/10/23 : 最終更新日：2015/01/12 Java Java, Java8

Java8 の Optional とガード節に続いて Java8 の Optional ネタ。今回は Generics を使ったタイプセーフな Optional 型を返すメソッドを定義する方法について。

photo credit: red5standingby via photopin cc

1. Generics を使って Optional クラスのインスタンスを返すメソッドの定義

あるオブジェクトを指定したクラスにキャストして、それを格納した Optional のインスタンスを返すメソッドを定義したかった。タイプセーフにキャストする方法はないものかと検索したら Stack Overflow で Class#cast() を使えばいいという記事を見つけた。

java – How do I make the method return type generic? – Stack Overflow

キャストの部分を抜き出しておく。

public <T extends Animal> T callFriend(String name, Class<T> type) {
    return type.cast(friends.get(name));
}

Generics の理解が浅いからこういう引数を設ければいいという発想にならなかった。

2. これを使って何がしたいのか

Generics を使ったタイプセーフな Optional 型を返すメソッドを使って何がしたかったのかというと、一時的に何でも格納できる「入れ物」が欲しくなったから。

せっかく Java8 を使っているのだから「取ってきた値が null じゃなかったら○○」みたいな if 文ではなく、Optional を使ってみたかった。お勉強も兼ねて Optional 型を戻り値にしてみよう、という発想からスタートしたもの。言葉だけではよく分からないので以下に実例を載せておく。

3. 「入れ物」クラスの実例

作ったというほどでもないが作ってみた。処理フローは次の通り。

キーとキャストしたい型の Class を受け取る
キーに対応する値を取得して指定の型にキャストする
キャストした値を引数に Optional#ofNullable() を実行してインスタンスを生成する
生成したインスタンスを return する

コードは次の通り。非常に単純。

/**
 * {@code Optional} を返すタイプセーフなキャッシュクラス。
 * 
 * @author tomoyamkung
 *
 */
public class OptionalCache {

    /**
     * キャッシュに使う {@code Map}。
     * 
     * {@code String} をキーとして、値はどんなクラスでも格納できるように {@code Object} とする。
     * 
     */
    private Map<String, Object> cache;

    /**
     * コンストラクタ。
     * 
     * キャッシュの初期化を行う。
     * 
     */
    public OptionalCache() {
        cache = new HashMap<>();
    }

    /**
     * キャッシュに値を登録する。
     * 
     * @param key 登録する値のキー。
     * @param value 登録する値。
     */
    public <V> void put(String key, V value) {
        Objects.requireNonNull(key, "key は必須。");

        cache.put(key, value);
    }

    /**
     * キャッシュから値を取得する。
     * 
     * @param key 取得する値のキー。
     * @param type キャストする型。
     * @return 取得した値を格納した {@code Optional}。
     */
    public <V> Optional<V> get(String key, Class<V> type) {
        Objects.requireNonNull(key, "key は必須。");

        return Optional.ofNullable(type.cast(cache.get(key)));
    }
}

3-1. `Optional#ofNullable()` を使っている理由

上記の処理フローの 2. で対応する値が登録されていない場合は cache.get(key) の結果で null が返ってくる。null の可能性がある場合は Optional#ofNullable() を使わないと、値を参照するときに NullPointerException になってしまう。なので、3. では Optional#ofNullable() を使っている。