java.lang.Object
java.util.Optional<T>
- 型パラメータ:
T
- 価値のタイプ
public final class Optional<T> extends Object
null
以外の値を含む場合と含まない場合があるコンテナ・オブジェクト。 値が存在する場合、isPresent()
はtrue
を返します。 値が存在しない場合、オブジェクトはemptyとみなされ、isPresent()
はfalse
を返します。
orElse()
(値がない場合はデフォルト値を返します)やifPresent()
(値が存在する場合にアクションを実行)など、含まれている値の有無に依存する追加のメソッドが提供されます。
これはvalue-basedクラスです。プログラマは、equalのインスタンスを交換可能として扱い、同期にインスタンスを使用しないようにする必要があります。そうしないと、予期しない動作が発生する可能性があります。 たとえば、将来のリリースでは、同期が失敗する可能性があります。
- APIのノート:
Optional
は、主に、"結果なし、"を表す明確な必要があり、null
を使用するとエラーが発生する可能性があるメソッドの戻り型として使用することを目的としています。 型がOptional
の変数は、それ自体がnull
になることはなく、常にOptional
インスタンスを指す必要があります。- 導入されたバージョン:
- 1.8
-
メソッドのサマリー
修飾子と型メソッド説明static <T> Optional
<T> empty()
空のOptional
インスタンスを返します。boolean
他のオブジェクトがこのOptional
に"に等しい"かどうかを示します。値が存在し、その値が指定された述語と一致する場合は、値を記述するOptional
を戻し、それ以外の場合は空のOptional
を戻します。<U> Optional
<U> 値が存在する場合は、指定されたOptional
-bearingマッピング関数を値に適用した結果を返し、それ以外の場合は空のOptional
を返します。get()
値が存在する場合は値を返し、存在しない場合はNoSuchElementException
をスローします。int
hashCode()
値のハッシュ・コード(存在する場合)を返します。値がない場合は0
(zero)を返します。void
値が存在する場合は、指定されたアクションを値とともに実行し、それ以外の場合は何も実行しません。void
ifPresentOrElse
(Consumer<? super T> action, Runnable emptyAction) 値が存在する場合は、指定されたアクションを値とともに実行し、それ以外の場合は、指定された空ベースのアクションを実行します。boolean
isEmpty()
値が存在しない場合はtrue
、それ以外の場合false
を返します。boolean
値が存在する場合、true
、それ以外の場合はfalse
を返します。<U> Optional
<U> 値が存在する場合は、指定されたマッピング関数を値に適用した結果として(ofNullable(T)
のように)を記述するOptional
を返し、それ以外の場合は空のOptional
を返します。static <T> Optional
<T> of
(T value) 指定された非null
値を記述するOptional
を返します。static <T> Optional
<T> ofNullable
(T value) null
以外の場合は、指定された値を記述するOptional
を返します。それ以外の場合は、空のOptional
を返します。値が存在する場合は、値を記述するOptional
を戻し、それ以外の場合は、指定関数によって生成されたOptional
を戻します。値が存在する場合は値を返し、存在しない場合はother
を返します。値が存在する場合は値を返し、それ以外の場合は供給関数によって生成された結果を返します。値が存在する場合は値を返し、存在しない場合はNoSuchElementException
をスローします。orElseThrow
(Supplier<? extends X> exceptionSupplier) 値が存在する場合は値を返し、それ以外の場合は例外指定関数によって生成された例外をスローします。stream()
値が存在する場合は、その値のみを含む順次Stream
を戻し、それ以外の場合は空のStream
を戻します。toString()
デバッグに適したこのOptional
の空でない文字列表現を返します。
-
メソッドの詳細
-
empty
public static <T> Optional<T> empty()空のOptional
インスタンスを返します。 このOptional
には値はありません。- APIのノート:
- これは一時的なものですが、
Optional.empty()
によって返されたインスタンスと==
または!=
を比較して、オブジェクトが空であるかどうかをテストしないでください。 シングルトンである保証はありません。 かわりに、isEmpty()
またはisPresent()
を使用してください。 - 型パラメータ:
T
- 存在しない値の型- 戻り値:
- 空の
Optional
。
-
of
public static <T> Optional<T> of(T value) 指定された非null
値を記述するOptional
を返します。- 型パラメータ:
T
- 値の型- パラメータ:
value
- 記述する値。null
以外である必要があります- 戻り値:
- 存在する値での
Optional
- 例外:
NullPointerException
- 値がnull
の場合
-
ofNullable
public static <T> Optional<T> ofNullable(T value) null
以外の場合は、指定された値を記述するOptional
を返します。それ以外の場合は、空のOptional
を返します。- 型パラメータ:
T
- 値の型- パラメータ:
value
- 説明するnull
の値- 戻り値:
- 指定された値が非
null
の場合は現在の値を持つOptional
、それ以外の場合は空のOptional
-
get
public T get()値が存在する場合は値を返し、存在しない場合はNoSuchElementException
をスローします。- APIのノート:
- このメソッドの代替として優先される方法は、
orElseThrow()
です。 - 戻り値:
- この
Optional
によって記述される非null
値 - 例外:
NoSuchElementException
- 値が存在しない場合
-
isPresent
public boolean isPresent()値が存在する場合、true
、それ以外の場合はfalse
を返します。- 戻り値:
- 値が存在する場合は
true
、存在しない場合はfalse
-
isEmpty
public boolean isEmpty()値が存在しない場合はtrue
、それ以外の場合false
を返します。- 戻り値:
- 値が存在しない場合は
true
、それ以外の場合はfalse
- 導入されたバージョン:
- 11
-
ifPresent
値が存在する場合は、指定されたアクションを値とともに実行し、それ以外の場合は何も実行しません。- パラメータ:
action
- 値が存在する場合、実行するアクション- 例外:
NullPointerException
- 値が存在し、与えられたアクションがnull
の場合
-
ifPresentOrElse
値が存在する場合は、指定されたアクションを値とともに実行し、それ以外の場合は、指定された空ベースのアクションを実行します。- パラメータ:
action
- 値が存在する場合、実行するアクションemptyAction
- 値が存在しない場合、実行される空ベースのアクション- 例外:
NullPointerException
- 値が存在し、指定されたアクションがnull
の場合、または値が存在しない場合、指定された空のアクションはnull
です。- 導入されたバージョン:
- 9
-
filter
値が存在し、その値が指定された述語と一致する場合は、値を記述するOptional
を戻し、それ以外の場合は空のOptional
を戻します。- パラメータ:
predicate
- 値に適用される述語(存在する場合)- 戻り値:
- この
Optional
の値を記述するOptional
(値が存在し、値が指定された述語と一致する場合)、それ以外の場合は空のOptional
- 例外:
NullPointerException
- 述語がnull
の場合
-
map
値が存在する場合は、指定されたマッピング関数を値に適用した結果として(ofNullable(T)
のように)を記述するOptional
を返し、それ以外の場合は空のOptional
を返します。マッピング関数が
null
の結果を返した場合、このメソッドは空のOptional
を返します。- APIのノート:
- このメソッドは、
Optional
値に対する後処理をサポートします。戻りステータスを明示的にチェックする必要はありません。 たとえば、次のコードはURIのストリームをトラバースし、まだ処理されていないものを選択して、そのURIからパスを作成し、Optional<Path>
を返します:
ここで、Optional<Path> p = uris.stream().filter(uri -> !isProcessedYet(uri)) .findFirst() .map(Paths::get);
findFirst
はOptional<URI>
を返し、map
は目的のURIが存在する場合はそのURIのOptional<Path>
を返します。 - 型パラメータ:
U
- マッピング関数から返される値の型- パラメータ:
mapper
- 値に適用するマッピング関数(存在する場合)- 戻り値:
- 値が存在する場合はマッピング関数をこの
Optional
の値に適用した結果を記述するOptional
、それ以外の場合は空のOptional
- 例外:
NullPointerException
- マッピング関数がnull
の場合
-
flatMap
値が存在する場合は、指定されたOptional
-bearingマッピング関数を値に適用した結果を返し、それ以外の場合は空のOptional
を返します。このメソッドは
map(Function)
と似ていますが、マッピング関数は、結果がすでにOptional
である関数であり、呼び出された場合、flatMap
はそれを追加のOptional
内でラップしません。- 型パラメータ:
U
- マッピング関数によって返されたOptional
の値の型- パラメータ:
mapper
- 値に適用するマッピング関数(存在する場合)- 戻り値:
- 値が存在する場合は
Optional
生成マッピング関数をこのOptional
の値に適用した結果、それ以外の場合は空のOptional
- 例外:
NullPointerException
- マッピング関数がnull
の場合、またはnull
の結果を返す場合
-
or
値が存在する場合は、値を記述するOptional
を戻し、それ以外の場合は、指定関数によって生成されたOptional
を戻します。- パラメータ:
supplier
- 戻されるOptional
を生成する供給関数- 戻り値:
- この
Optional
の値を記述するOptional
を返します(値が存在する場合)。それ以外の場合は、指定関数によって生成されるOptional
を返します。 - 例外:
NullPointerException
- 供給関数がnull
またはnull
結果を生成する場合- 導入されたバージョン:
- 9
-
stream
-
orElse
-
orElseGet
値が存在する場合は値を返し、それ以外の場合は供給関数によって生成された結果を返します。- パラメータ:
supplier
- 戻される値を生成する供給関数- 戻り値:
- 値が存在する場合は、それ以外の場合は、供給機能によって生成される結果
- 例外:
NullPointerException
- 値が存在せず、供給関数がnull
の場合
-
orElseThrow
public T orElseThrow()値が存在する場合は値を返し、存在しない場合はNoSuchElementException
をスローします。- 戻り値:
- この
Optional
によって記述される非null
値 - 例外:
NoSuchElementException
- 値が存在しない場合- 導入されたバージョン:
- 10
-
orElseThrow
値が存在する場合は値を返し、それ以外の場合は例外指定関数によって生成された例外をスローします。- APIのノート:
- 引数リストが空である例外コンストラクタへのメソッド参照をサプライヤとして使用できます。 たとえば、
IllegalStateException::new
などです。 - 型パラメータ:
X
- スローされる例外の型- パラメータ:
exceptionSupplier
- スローされる例外を生成する供給関数- 戻り値:
- 値がある場合
- 例外:
X
- 値が存在しない場合NullPointerException
- 値が存在せず、例外を提供する関数がnull
の場合
-
equals
-
hashCode
-
toString
-