compact1, compact2, compact3

java.util

Class Optional<T>

java.lang.Object

java.util.Optional<T>

public final class Optional<T>
extends Object

一个容器对象，它可以或可能不包含非空值。如果一个值是存在的， isPresent()将返回 true和 get()将返回值。

提供了更多的方法，取决于一个有价值的存在或不存在，如orElse()（如果值不存在返回一个默认值）和ifPresent()（如果值为当前执行的代码块）。

这是一个value-based类；利用身份敏感的操作（包括引用相等（==），身份的哈希代码，或同步）的实例Optional可能有不可预知的结果应该是可以避免的。

从以下版本开始：

一点八

方法摘要

Modifier and Type	Method and Description
static <T> Optional<T>	empty() 返回一个空 Optional实例。
boolean	equals(Object obj) 指示是否有其他对象“等于”此选项。
Optional<T>	filter(Predicate<? super T> predicate) 如果一个值是存在的，而价值匹配给定谓词，返回一个 Optional描述值，否则返回一个空 Optional。
<U> Optional<U>	flatMap(Function<? super T,Optional<U>> mapper) 如果一个值是存在的，将提供 Optional-bearing映射函数，返回结果，否则返回一个空 Optional。
T	get() 如果一个值是在这 Optional，返回值，否则将 NoSuchElementException。
int	hashCode() 返回当前值的哈希代码值，如果有的话，或0（0），如果没有价值。
void	ifPresent(Consumer<? super T> consumer) 如果一个值存在，调用指定的值的指定的用户，否则什么都不做。
boolean	isPresent() 返回 true如果有存在价值，否则 false。
<U> Optional<U>	map(Function<? super T,? extends U> mapper) 如果一个值是存在的，申请提供的映射函数，如果结果不为空，返回一个 Optional描述结果。
static <T> Optional<T>	of(T value) 返回与指定非空值的 Optional目前。
static <T> Optional<T>	ofNullable(T value) 返回一个 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() 返回此可选适用于调试的非空字符串表示形式。

Methods inherited from class java.lang.Object

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

方法详细信息

empty

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

返回一个空 Optional实例。没有价值是为这个可选的。

API Note:

虽然它可能会这样做，如果一个对象是由 ==对返回的实例比较 Option.empty()空避免测试。没有保证它是一个单身。相反，使用 isPresent()。

参数类型

T -不存在的值类型

结果

一个空的 Optional

of

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

返回与指定非空值的 Optional目前。

参数类型

T -值的类

参数

value -存在的价值，它必须是非空

结果

随着价值提出了一个 Optional

异常

NullPointerException如果值为空

ofNullable

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

返回一个 Optional描述指定的值，如果非零，则返回一个空 Optional。

参数类型

T -值的类

参数

value -可能的空值来描述

结果

一个 Optional与现值如果指定值非零，否则空 Optional

get

public T get()

如果一个值是在这 Optional，返回值，否则将 NoSuchElementException。

结果

非空的值 Optional举行

异常

NoSuchElementException -如果没有存在价值

另请参见：

isPresent()

isPresent

public boolean isPresent()

如果有一个价值回归 true，否则 false。

结果

true如果有存在价值，否则 false

ifPresent

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

如果一个值存在，调用指定的值的指定的用户，否则什么都不做。

参数

consumer块被执行，如果一个值是否存在

异常

NullPointerException如果值是当前和 consumer是空的

filter

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

如果一个值是存在的，而价值匹配给定谓词，返回一个 Optional描述值，否则返回一个空 Optional。

参数

predicate -谓词应用到价值，如果存在

结果

一个 Optional描述这 Optional价值如果价值存在和价值匹配给定谓词，否则空 Optional

异常

NullPointerException如果谓语是空的

map

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

如果一个值是存在的，申请提供的映射函数，如果结果不为空，返回一个 Optional描述结果。否则，返回一个空 Optional。

API Note:

此方法支持对可选值的后处理，而不需要显式地检查返回状态。例如，下面的代码遍历流文件名称，选择一个尚未被处理，然后打开该文件，返回一个 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如果映射函数为零

flatMap

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

如果一个值是存在的，将提供 Optional-bearing映射函数，返回结果，否则返回一个空 Optional。这种方法类似于 map(Function)，但是提供的映射是一个其结果已经是一个 Optional，如果调用， flatMap裹不住它一个额外的 Optional。

参数类型

U -类型参数的 Optional返回

参数

mapper -映射函数应用到价值，如果目前的映射函数

结果

将 Optional-bearing映射功能，这 Optional值的结果，如果一个值是存在的，否则一个空 Optional

异常

NullPointerException如果映射函数为零或返回空结果

orElse

public T orElse(T other)

如果目前的返回值，否则返回 other。

参数

other -是没有存在价值的返回值，可能是空的

结果

的值，如果存在，否则 other

orElseGet

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

如果目前的返回值，否则调用 other并返回调用结果的。

参数

other - Supplier其结果返回如果没有价值存在

结果

如果存在其他的价值 other.get()结果

异常

NullPointerException如果值不存在， other是空的

orElseThrow

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

返回所包含的值，如果存在的话，否则抛出一个由提供的供应商创建的异常。

API Note:

一个空参数列表的异常构造函数的方法引用，可以作为供应商使用。例如， IllegalStateException::new

参数类型

X -被抛出的异常类型

参数

exceptionSupplier -供应商将被抛出的异常

结果

目前的价值

异常

X -如果没有存在价值

NullPointerException -如果没有价值存在， exceptionSupplier是空的

X extends Throwable

equals

public boolean equals(Object obj)

指示是否有其他对象“等于”此选项。其他的对象是相同的：如果

• 这也是一个Optional和；
• 这两个实例都没有值存在或；
• 目前的价值观是“等于”彼此通过equals()。

重写：

equals 方法重写，继承类 Object

参数

obj对象进行平等

结果

{代码}如果真的其他对象是“等于”这个对象，否则 false

另请参见：

Object.hashCode()， HashMap

hashCode

public int hashCode()

返回当前值的哈希代码值，如果有的话，或0（0），如果没有价值。

重写：

hashCode 方法重写，继承类 Object

结果

如果没有值，则本值或0的哈希代码值

另请参见：

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

toString

public String toString()

返回此可选适用于调试的非空字符串表示形式。确切的演示文稿格式是未知的，可能会在实现和版本之间有所不同。

重写：

toString 方法重写，继承类 Object

实现要求：

如果一个值存在，则结果必须包括其结果中的字符串表示形式。空和自选项目必须明确微。

结果

此实例的字符串表示形式