compact1, compact2, compact3

java.util

クラスOptional<T>

java.lang.Object

java.util.Optional<T>

public final class Optional<T>
extends Object

null以外の値が含まれている場合も含まれていない場合もあるコンテナ・オブジェクトです。値が存在する場合、isPresent()はtrueを返し、get()は値を返します。

含まれる値の有無に応じて追加メソッドが提供されます。たとえば、orElse() (値が存在しない場合にデフォルト値を返す)、ifPresent() (値が存在する場合にコードのブロックを実行する)など。

これは値ベースのクラスで、Optionalのインスタンスに対して、ID依存操作(参照等価性(==)、IDハッシュ・コード、同期など)を使用すると、予期できない結果になる可能性があり、避けてください。

導入されたバージョン:

1.8

メソッドのサマリー

修飾子と型	メソッドと説明
static <T> Optional<T>	empty() 空のOptionalインスタンスを返します。
boolean	equals(Object obj) 一部の他のオブジェクトがこのOptionalと等しいかどうかを示します。
Optional<T>	filter(Predicate<? super T> predicate) 値が存在し、それが指定された述語に一致する場合はその値を記述するOptionalを返し、そうでない場合は空のOptionalを返します。
<U> Optional<U>	flatMap(Function<? super T,Optional<U>> mapper) 値が存在する場合は、指定されたOptional生成マッピング関数をその値に適用し、その結果を返します。そうでない場合は空のOptionalを返します。
T	get() このOptionalに値が存在する場合は値を返し、それ以外の場合はNoSuchElementExceptionをスローします。
int	hashCode() 存在する値のハッシュ・コード値(ある場合)を返し、値が存在しない場合は0 (ゼロ)を返します。
void	ifPresent(Consumer<? super T> consumer) 値が存在する場合は指定されたコンシューマをその値で呼び出し、それ以外の場合は何も行いません。
boolean	isPresent() 存在する値がある場合はtrueを返し、それ以外の場合はfalseを返します。
<U> Optional<U>	map(Function<? super T,? extends U> mapper) 値が存在する場合は、指定されたマッピング関数をその値に適用し、結果がnullでなければ結果を記述するOptionalを返します。
static <T> Optional<T>	of(T value) 指定された非null値を含むOptionalを返します。
static <T> Optional<T>	ofNullable(T value) 指定された値がnullでない場合はその値を記述するOptionalを返し、それ以外の場合は空のOptionalを返します。
T	orElse(T other) 存在する場合は値を返し、それ以外の場合はotherを返します。
T	orElseGet(Supplier<? extends T> other) 値が存在する場合はその値を返し、そうでない場合はotherを呼び出し、その呼び出しの結果を返します。
<X extends Throwable> T	orElseThrow(Supplier<? extends X> exceptionSupplier) 値が存在する場合は、その含まれている値を返し、それ以外の場合は、指定されたサプライヤによって作成された例外をスローします。
String	toString() デバッグに適しているこのOptionalの空ではない文字列表現を返します。

クラス java.lang.Objectから継承されたメソッド

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

メソッドの詳細

empty

public static <T> Optional<T> empty()

空のOptionalインスタンスを返します。このOptionalの値は存在しません。

APIの注:

Option.empty()で返されたインスタンスに対して==で比較することによってオブジェクトが空かどうかを判定しないでください(そうしたいかもしれませんが)。シングルトンである保証はありません。かわりにisPresent()を使用してください。

型パラメータ:

T - 存在しない値の型

戻り値:

空のOptional。

of

public static <T> Optional<T> of(T value)

指定された非null値を含むOptionalを返します。

型パラメータ:

T - 値のクラス

パラメータ:

value - 存在する値、非nullである必要がある

戻り値:

存在する値でのOptional

例外:

NullPointerException - valueがnullの場合。

ofNullable

public static <T> Optional<T> ofNullable(T value)

指定された値がnullでない場合はその値を記述するOptionalを返し、それ以外の場合は空のOptionalを返します。

型パラメータ:

T - 値のクラス

パラメータ:

value - 記述する値(nullも可)

戻り値:

指定された値がnullでない場合は存在する値でのOptional、それ以外の場合は空のOptional

get

public T get()

このOptionalに値が存在する場合は値を返し、それ以外の場合はNoSuchElementExceptionをスローします。

戻り値:

このOptionalが保持する非null値

例外:

NoSuchElementException - 存在する値がない場合

関連項目:

isPresent()

isPresent

public boolean isPresent()

存在する値がある場合はtrueを返し、それ以外の場合はfalseを返します。

戻り値:

存在する値がない場合はtrue、それ以外の場合はfalse

ifPresent

public void ifPresent(Consumer<? super T> consumer)

値が存在する場合は指定されたコンシューマをその値で呼び出し、それ以外の場合は何も行いません。

パラメータ:

consumer - 値が存在する場合に実行されるブロック

例外:

NullPointerException - 値が存在しconsumerがnullの場合

filter

public Optional<T> filter(Predicate<? super T> predicate)

値が存在し、それが指定された述語に一致する場合はその値を記述するOptionalを返し、そうでない場合は空のOptionalを返します。

パラメータ:

predicate - 存在する場合は値に適用する述語

戻り値:

値が存在して値が指定された述語にマッチする場合は、このOptionalの値を記述するOptional、それ以外の場合は空のOptional

例外:

NullPointerException - 述語がnullの場合

map

public <U> Optional<U> map(Function<? super T,? extends U> mapper)

値が存在する場合は、指定されたマッピング関数をその値に適用し、結果がnullでなければ結果を記述するOptionalを返します。それ以外の場合は空のOptionalを返します。

APIの注:

このメソッドは、戻りステータスの明示的なチェックを必要としない、Optional値の後処理をサポートします。たとえば、次のコードはファイル名のストリームをトラバースし、まだ処理されていないものを選択してから、そのファイルを開き、Optional<FileInputStream>を返します。

     Optional<FileInputStream> fis =
         names.stream().filter(name -> !isProcessedYet(name))
                       .findFirst()
                       .map(name -> new FileInputStream(name));
 

ここで、findFirstはOptional<String>を返してから、mapは求めているファイル(存在する場合)のOptional<FileInputStream>を返します。

型パラメータ:

U - マッピング関数の結果の型

パラメータ:

mapper - 値に適用するマッピング関数(存在する場合)

戻り値:

値が存在する場合はマッピング関数をこのOptionalの値に適用した結果を記述するOptional、それ以外の場合は空のOptional

例外:

NullPointerException - マッピング関数がnullの場合

flatMap

public <U> Optional<U> flatMap(Function<? super T,Optional<U>> mapper)

値が存在する場合は、指定されたOptional生成マッピング関数をその値に適用し、その結果を返します。そうでない場合は空のOptionalを返します。このメソッドはmap(Function)に似ていますが、指定されるマッパーは結果がすでにOptionalであるマッパーで、flatMapは呼び出されても追加のOptionalでラップしません。

型パラメータ:

U - 返されるOptionalへの型パラメータ

パラメータ:

mapper - 値(存在する場合)に適用するマッピング関数

戻り値:

値が存在する場合はOptional生成マッピング関数をこのOptionalの値に適用した結果、それ以外の場合は空のOptional

例外:

NullPointerException - マッピング関数がnull、またはnull結果を返す場合

orElse

public T orElse(T other)

存在する場合は値を返し、それ以外の場合はotherを返します。

パラメータ:

other - 存在する値がない場合に返される値、nullも可

戻り値:

値(存在する場合)、それ以外の場合はother

orElseGet

public T orElseGet(Supplier<? extends T> other)

値が存在する場合はその値を返し、そうでない場合はotherを呼び出し、その呼び出しの結果を返します。

パラメータ:

other - Supplier(値が存在しない場合は、これの結果が返される)

戻り値:

値(存在する場合)、それ以外の場合はother.get()の結果

例外:

NullPointerException - 値が存在せずotherがnullの場合

orElseThrow

public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)
                                    throws X extends Throwable

値が存在する場合は、その含まれている値を返し、それ以外の場合は、指定されたサプライヤによって作成された例外をスローします。

APIの注:

引数リストが空である例外コンストラクタへのメソッド参照をサプライヤとして使用できます。たとえば、IllegalStateException::newなどです。

型パラメータ:

X - スローされる例外の型

パラメータ:

exceptionSupplier - スローされる例外を返すサプライヤ

戻り値:

存在する値

例外:

X - 存在する値がない場合

NullPointerException - 値が存在せずexceptionSupplierがnullの場合

X extends Throwable

equals

public boolean equals(Object obj)

一部の他のオブジェクトがこのOptionalと等しいかどうかを示します。他方のオブジェクトは次の場合に同等と見なされます。

• それもOptionalである、および
• 両方のインスタンスに存在する値がない、または
• 存在する値がequals()によってお互いに等しい。

オーバーライド:

equals、クラス: Object

パラメータ:

obj - 等価性を判定されるオブジェクト

戻り値:

他方のオブジェクトがこのオブジェクトと等しい場合は{code true}、それ以外の場合はfalse

関連項目:

Object.hashCode(), HashMap

hashCode

public int hashCode()

存在する値のハッシュ・コード値(ある場合)を返し、値が存在しない場合は0 (ゼロ)を返します。

オーバーライド:

hashCode、クラス: Object

戻り値:

存在する値のハッシュ・コード値、値が存在しない場合は0

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

デバッグに適しているこのOptionalの空ではない文字列表現を返します。正確な表示フォーマットは未指定であり、実装とバージョンの間で異なることがあります。

オーバーライド:

toString、クラス: Object

実装要件:

値が存在する場合は、結果にその文字列表現が含まれる必要があります。空および存在するOptionalは明確に区別できる必要があります。

戻り値:

このインスタンスの文字列表現