Opt (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.lang.Opt<T>

Type Parameters:

T - 包裹里元素的类型
```
public class Opt<T>
extends Object
```
复制jdk16中的Optional，以及自己进行了一点调整和新增，比jdk8中的Optional多了几个实用的函数
详细见：https://gitee.com/dromara/hutool/pulls/426

Author:

VampireAchao

See Also:

Optional

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Opt<T>`	`empty()` 返回一个空的`Opt`
`boolean`	`equals(Object obj)` 判断传入参数是否与 `Opt`相等在以下情况下返回true 它也是一个 `Opt` 并且它们包裹住的元素都为空或者它们包裹住的元素之间相互 `equals()`
`T`	`exceptionOrElse(T other)` 异常则返回另一个可选值
`Opt<T>`	`filter(Predicate<? super T> predicate)` 判断包裹里的值存在并且与给定的条件是否满足 (`Predicate.test(T)`执行结果是否为true) 如果满足条件则返回本身不满足条件或者元素本身为空时返回一个返回一个空的`Opt`
`<U> Opt<U>`	`flatMap(Function<? super T,? extends Opt<? extends U>> mapper)` 如果包裹里的值存在，就执行传入的操作(`Function.apply(T)`)并返回该操作返回值如果不存在，返回一个空的`Opt` 和 `map(java.util.function.Function<? super T, ? extends U>)`的区别为传入的操作返回值必须为 Opt
`<U> Opt<U>`	`flattedMap(Function<? super T,? extends Optional<? extends U>> mapper)` 如果包裹里的值存在，就执行传入的操作(`Function.apply(T)`)并返回该操作返回值如果不存在，返回一个空的`Opt` 和 `map(java.util.function.Function<? super T, ? extends U>)`的区别为传入的操作返回值必须为 `Optional`
`T`	`get()` 返回包裹里的元素，取不到则为`null`，注意！！！
`Exception`	`getException()` 获取异常当调用 `ofTry(Func0)`时，异常信息不会抛出，而是保存，调用此方法获取抛出的异常
`int`	`hashCode()` 如果包裹内元素为空，则返回0，否则返回元素的 `hashcode`
`Opt<T>`	`ifFail(Consumer<? super Throwable> action)` 如果包裹内容失败了，则执行传入的操作(`Consumer.accept(T)`) 例如执行有异常就打印结果 `Opt.ofTry(() -> 1 / 0).ifFail(Console::log);`
`Opt<T>`	`ifPresent(Consumer<? super T> action)` 如果包裹里的值存在，就执行传入的操作(`Consumer.accept(T)`) 例如如果值存在就打印结果 {@code Opt.ofNullable("Hello Hutool!").
`Opt<T>`	`ifPresentOrElse(Consumer<? super T> action, VoidFunc0 emptyAction)` 如果包裹里的值存在，就执行传入的值存在时的操作(`Consumer.accept(T)`) 否则执行传入的值不存在时的操作(`VoidFunc0`中的`VoidFunc0.call()`) 例如值存在就打印对应的值，不存在则用`Console.error`打印另一句字符串 {@code Opt.ofNullable("Hello Hutool!").
`boolean`	`isEmpty()` 判断包裹里元素的值是否不存在，不存在为 `true`，否则为`false`
`boolean`	`isFail()` 是否失败当调用 `ofTry(Func0)`时，抛出异常则表示失败
`boolean`	`isPresent()` 判断包裹里元素的值是否存在，存在为 `true`，否则为`false`
`<U> Opt<U>`	`map(Function<? super T,? extends U> mapper)` 如果包裹里的值存在，就执行传入的操作(`Function.apply(T)`)并返回一个包裹了该操作返回值的`Opt` 如果不存在，返回一个空的`Opt`
`<U> Opt<U>`	`mapOrElse(Function<? super T,? extends U> mapper, VoidFunc0 emptyAction)` 如果包裹里的值存在，就执行传入的值存在时的操作(`Function.apply(Object)`)支持链式调用、转换为其他类型否则执行传入的值不存在时的操作(`VoidFunc0`中的`VoidFunc0.call()`) 如果值存在就转换为大写，否则用`Console.error`打印另一句字符串 `String hutool = Opt.ofBlankAble("hutool").mapOrElse(String::toUpperCase, () -> Console.log("yes")).mapOrElse(String::intern, () -> Console.log("Value is not present~")).get();`
`static <T> Opt<T>`	`of(T value)` 返回一个包裹里元素不可能为空的`Opt`
`static <T> Opt<T>`	`ofBlankAble(T value)` 返回一个包裹里元素可能为空的`Opt`，额外判断了空字符串的情况
`static <T,R extends Collection<T>> Opt<R>`	`ofEmptyAble(R value)` 返回一个包裹里`List`集合可能为空的`Opt`，额外判断了集合内元素为空的情况
`static <T> Opt<T>`	`ofNullable(T value)` 返回一个包裹里元素可能为空的`Opt`
`static <T> Opt<T>`	`ofTry(Func0<T> supplier)`
`Opt<T>`	`or(Supplier<? extends Opt<? extends T>> supplier)` 如果包裹里元素的值存在，就返回本身，如果不存在，则使用传入的操作执行后获得的 `Opt`
`T`	`orElse(T other)` 如果包裹里元素的值存在，则返回该值，否则返回传入的`other`
`T`	`orElseGet(Supplier<? extends T> supplier)` 如果包裹里元素的值存在，则返回该值，否则返回传入的操作执行后的返回值
`T`	`orElseThrow()` 如果包裹里的值存在，则返回该值，否则抛出 `NoSuchElementException`
`<X extends Throwable> T`	`orElseThrow(Function<String,? extends X> exceptionFunction, String message)` 如果包裹里的值存在，则返回该值，否则执行传入的操作，获取异常类型的返回值并抛出往往是一个包含自定义消息构造器的异常例如 {@code Opt.ofNullable(null).orElseThrow(IllegalStateException::new, "Ops!
`<X extends Throwable> T`	`orElseThrow(Supplier<? extends X> exceptionSupplier)` 如果包裹里的值存在，则返回该值，否则执行传入的操作，获取异常类型的返回值并抛出往往是一个包含无参构造器的异常例如传入`IllegalStateException::new`
`Opt<T>`	`peek(Consumer<T> action)` 如果包裹里元素的值存在，就执行对应的操作，并返回本身如果不存在，返回一个空的`Opt` 属于 `ifPresent(java.util.function.Consumer<? super T>)`的链式拓展
`Opt<T>`	`peeks(Consumer<T>... actions)` 如果包裹里元素的值存在，就执行对应的操作集，并返回本身如果不存在，返回一个空的`Opt` 属于 `ifPresent(java.util.function.Consumer<? super T>)`的链式拓展属于 `peek(Consumer)`的动态拓展
`Stream<T>`	`stream()` 如果包裹里元素的值存在，就返回一个包含该元素的 `Stream`, 否则返回一个空元素的 `Stream` 该方法能将 Opt 中的元素传递给 `Stream` {@code Stream> os = ..
`Optional<T>`	`toOptional()` 转换为 `Optional`对象
`String`	`toString()` 返回包裹内元素调用`toString()`的结果，不存在则返回`null`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
 - empty
```
public static <T> Opt<T> empty()
```
 返回一个空的Opt
 
 Type Parameters:
 
 T - 包裹里元素的类型
 
 Returns:
 
 Opt
 - of
```
public static <T> Opt<T> of(T value)
```
 返回一个包裹里元素不可能为空的Opt
 
 Type Parameters:
 
 T - 包裹里元素的类型
 
 Parameters:
 
 value - 包裹里的元素
 
 Returns:
 
 一个包裹里元素不可能为空的 Opt
 
 Throws:
 
 NullPointerException - 如果传入的元素为空，抛出 NPE
 - ofNullable
```
public static <T> Opt<T> ofNullable(T value)
```
 返回一个包裹里元素可能为空的Opt
 
 Type Parameters:
 
 T - 包裹里元素的类型
 
 Parameters:
 
 value - 传入需要包裹的元素
 
 Returns:
 
 一个包裹里元素可能为空的 Opt
 - ofBlankAble
```
public static <T> Opt<T> ofBlankAble(T value)
```
 返回一个包裹里元素可能为空的Opt，额外判断了空字符串的情况
 
 Type Parameters:
 
 T - 包裹里元素的类型
 
 Parameters:
 
 value - 传入需要包裹的元素
 
 Returns:
 
 一个包裹里元素可能为空，或者为空字符串的 Opt
 - ofEmptyAble
```
public static <T,R extends Collection<T>> Opt<R> ofEmptyAble(R value)
```
 返回一个包裹里List集合可能为空的Opt，额外判断了集合内元素为空的情况
 
 Type Parameters:
 
 T - 包裹里元素的类型
 
 R - 集合值类型
 
 Parameters:
 
 value - 传入需要包裹的元素，支持CharSequence、Map、Iterable、Iterator、Array类型
 
 Returns:
 
 一个包裹里元素可能为空的 Opt
 
 Since:
 
 5.7.17
 - ofTry
```
public static <T> Opt<T> ofTry(Func0<T> supplier)
```
 Type Parameters:
 
 T - 类型
 
 Parameters:
 
 supplier - 操作
 
 Returns:
 
 操作执行后的值
 - get
```
public T get()
```
 返回包裹里的元素，取不到则为null，注意！！！此处和Optional.get()不同的一点是本方法并不会抛出NoSuchElementException 如果元素为空，则返回null，如果需要一个绝对不能为null的值，则使用orElseThrow()
 如果需要一个绝对不能为 null的值，则使用orElseThrow() 做此处修改的原因是，有时候我们确实需要返回一个null给前端，并且这样的时候并不少见而使用 .orElse(null)需要写整整12个字符，用.get()就只需要6个啦
 
 Returns:
 
 包裹里的元素，有可能为null
 - isEmpty
```
public boolean isEmpty()
```
 判断包裹里元素的值是否不存在，不存在为 true，否则为false
 
 Returns:
 
 包裹里元素的值不存在则为 true，否则为false
 
 Since:
 
 11 这是jdk11Optional中的新函数
 - getException
```
public Exception getException()
```
 获取异常
 当调用 ofTry(Func0)时，异常信息不会抛出，而是保存，调用此方法获取抛出的异常
 
 Returns:
 
 异常
 
 Since:
 
 5.7.17
 - isFail
```
public boolean isFail()
```
 是否失败
 当调用 ofTry(Func0)时，抛出异常则表示失败
 
 Returns:
 
 是否失败
 
 Since:
 
 5.7.17
 - ifFail
```
public Opt<T> ifFail(Consumer<? super Throwable> action)
 throws NullPointerException
```
 如果包裹内容失败了，则执行传入的操作(Consumer.accept(T))
 例如执行有异常就打印结果
```
 Opt.ofTry(() -> 1 / 0).ifFail(Console::log);
 
```
 Parameters:
 
 action - 你想要执行的操作
 
 Returns:
 
 this
 
 Throws:
 
 NullPointerException - 如果包裹里的值存在，但你传入的操作为null时抛出
 - isPresent
```
public boolean isPresent()
```
 判断包裹里元素的值是否存在，存在为 true，否则为false
 
 Returns:
 
 包裹里元素的值存在为 true，否则为false
 - ifPresent
```
public Opt<T> ifPresent(Consumer<? super T> action)
```
 如果包裹里的值存在，就执行传入的操作(Consumer.accept(T))
 例如如果值存在就打印结果
```
 Opt.ofNullable("Hello Hutool!").ifPresent(Console::log);
 
```
 Parameters:
 
 action - 你想要执行的操作
 
 Returns:
 
 this
 
 Throws:
 
 NullPointerException - 如果包裹里的值存在，但你传入的操作为null时抛出
 - ifPresentOrElse
```
public Opt<T> ifPresentOrElse(Consumer<? super T> action,
 VoidFunc0 emptyAction)
```
 如果包裹里的值存在，就执行传入的值存在时的操作(Consumer.accept(T)) 否则执行传入的值不存在时的操作(VoidFunc0中的VoidFunc0.call())
 例如值存在就打印对应的值，不存在则用Console.error打印另一句字符串
```
 Opt.ofNullable("Hello Hutool!").ifPresentOrElse(Console::log, () -> Console.error("Ops!Something is wrong!"));
 
```
 Parameters:
 
 action - 包裹里的值存在时的操作
 
 emptyAction - 包裹里的值不存在时的操作
 
 Returns:
 
 this;
 
 Throws:
 
 NullPointerException - 如果包裹里的值存在时，执行的操作为 null, 或者包裹里的值不存在时的操作为 null，则抛出NPE
 - mapOrElse
```
public  Opt mapOrElse(Function<? super T,? extends U> mapper,
 VoidFunc0 emptyAction)
```
 如果包裹里的值存在，就执行传入的值存在时的操作(Function.apply(Object))支持链式调用、转换为其他类型否则执行传入的值不存在时的操作(VoidFunc0中的VoidFunc0.call())
 如果值存在就转换为大写，否则用Console.error打印另一句字符串
```
 String hutool = Opt.ofBlankAble("hutool").mapOrElse(String::toUpperCase, () -> Console.log("yes")).mapOrElse(String::intern, () -> Console.log("Value is not present~")).get();
 
```
 Type Parameters:
 
 U - map后新的类型
 
 Parameters:
 
 mapper - 包裹里的值存在时的操作
 
 emptyAction - 包裹里的值不存在时的操作
 
 Returns:
 
 新的类型的Opt
 
 Throws:
 
 NullPointerException - 如果包裹里的值存在时，执行的操作为 null, 或者包裹里的值不存在时的操作为 null，则抛出NPE
 - filter
```
public Opt<T> filter(Predicate<? super T> predicate)
```
 判断包裹里的值存在并且与给定的条件是否满足 (Predicate.test(T)执行结果是否为true) 如果满足条件则返回本身不满足条件或者元素本身为空时返回一个返回一个空的Opt
 
 Parameters:
 
 predicate - 给定的条件
 
 Returns:
 
 如果满足条件则返回本身, 不满足条件或者元素本身为空时返回一个空的Opt
 
 Throws:
 
 NullPointerException - 如果给定的条件为 null，抛出NPE
 - map
```
public  Opt map(Function<? super T,? extends U> mapper)
```
 如果包裹里的值存在，就执行传入的操作(Function.apply(T))并返回一个包裹了该操作返回值的Opt 如果不存在，返回一个空的Opt
 
 Type Parameters:
 
 U - 操作返回值的类型
 
 Parameters:
 
 mapper - 值存在时执行的操作
 
 Returns:
 
 如果包裹里的值存在，就执行传入的操作(Function.apply(T))并返回一个包裹了该操作返回值的Opt，如果不存在，返回一个空的Opt
 
 Throws:
 
 NullPointerException - 如果给定的操作为 null，抛出 NPE
 - flatMap
```
public  Opt flatMap(Function<? super T,? extends Opt<? extends U>> mapper)
```
 如果包裹里的值存在，就执行传入的操作(Function.apply(T))并返回该操作返回值如果不存在，返回一个空的Opt 和 map(java.util.function.Function<? super T, ? extends U>)的区别为传入的操作返回值必须为 Opt
 
 Type Parameters:
 
 U - 操作返回值的类型
 
 Parameters:
 
 mapper - 值存在时执行的操作
 
 Returns:
 
 如果包裹里的值存在，就执行传入的操作(Function.apply(T))并返回该操作返回值如果不存在，返回一个空的Opt
 
 Throws:
 
 NullPointerException - 如果给定的操作为 null或者给定的操作执行结果为 null，抛出 NPE
 - flattedMap
```
public  Opt flattedMap(Function<? super T,? extends Optional<? extends U>> mapper)
```
 如果包裹里的值存在，就执行传入的操作(Function.apply(T))并返回该操作返回值如果不存在，返回一个空的Opt 和 map(java.util.function.Function<? super T, ? extends U>)的区别为传入的操作返回值必须为 Optional
 
 Type Parameters:
 
 U - 操作返回值的类型
 
 Parameters:
 
 mapper - 值存在时执行的操作
 
 Returns:
 
 如果包裹里的值存在，就执行传入的操作(Function.apply(T))并返回该操作返回值如果不存在，返回一个空的Opt
 
 Throws:
 
 NullPointerException - 如果给定的操作为 null或者给定的操作执行结果为 null，抛出 NPE
 
 Since:
 
 5.7.16
 
 See Also:
 
 Optional.flatMap(Function)
 - peek
```
public Opt<T> peek(Consumer<T> action)
 throws NullPointerException
```
 如果包裹里元素的值存在，就执行对应的操作，并返回本身如果不存在，返回一个空的Opt
 属于 ifPresent(java.util.function.Consumer<? super T>)的链式拓展
 
 Parameters:
 
 action - 值存在时执行的操作
 
 Returns:
 
 this
 
 Throws:
 
 NullPointerException - 如果值存在，并且传入的操作为 null
 - peeks
```
@SafeVarargs
public final Opt<T> peeks(Consumer<T>... actions)
 throws NullPointerException
```
 如果包裹里元素的值存在，就执行对应的操作集，并返回本身如果不存在，返回一个空的Opt
 属于 ifPresent(java.util.function.Consumer<? super T>)的链式拓展
 属于 peek(Consumer)的动态拓展
 
 Parameters:
 
 actions - 值存在时执行的操作，动态参数，可传入数组，当数组为一个空数组时并不会抛出 NPE
 
 Returns:
 
 this
 
 Throws:
 
 NullPointerException - 如果值存在，并且传入的操作集中的元素为 null
 - or
```
public Opt<T> or(Supplier<? extends Opt<? extends T>> supplier)
```
 如果包裹里元素的值存在，就返回本身，如果不存在，则使用传入的操作执行后获得的 Opt
 
 Parameters:
 
 supplier - 不存在时的操作
 
 Returns:
 
 如果包裹里元素的值存在，就返回本身，如果不存在，则使用传入的函数执行后获得的 Opt
 
 Throws:
 
 NullPointerException - 如果传入的操作为空，或者传入的操作执行后返回值为空，则抛出 NPE
 - stream
```
public Stream<T> stream()
```
 如果包裹里元素的值存在，就返回一个包含该元素的 Stream, 否则返回一个空元素的 Stream
 该方法能将 Opt 中的元素传递给 Stream
```
 Stream<Opt<T>> os = ..
 Stream<T> s = os.flatMap(Opt::stream)
 
```
 Returns:
 
 返回一个包含该元素的 Stream或空的 Stream
 - orElse
```
public T orElse(T other)
```
 如果包裹里元素的值存在，则返回该值，否则返回传入的other
 
 Parameters:
 
 other - 元素为空时返回的值，有可能为 null.
 
 Returns:
 
 如果包裹里元素的值存在，则返回该值，否则返回传入的other
 - exceptionOrElse
```
public T exceptionOrElse(T other)
```
 异常则返回另一个可选值
 
 Parameters:
 
 other - 可选值
 
 Returns:
 
 如果未发生异常，则返回该值，否则返回传入的other
 
 Since:
 
 5.7.17
 - orElseGet
```
public T orElseGet(Supplier<? extends T> supplier)
```
 如果包裹里元素的值存在，则返回该值，否则返回传入的操作执行后的返回值
 
 Parameters:
 
 supplier - 值不存在时需要执行的操作，返回一个类型与包裹里元素类型相同的元素
 
 Returns:
 
 如果包裹里元素的值存在，则返回该值，否则返回传入的操作执行后的返回值
 
 Throws:
 
 NullPointerException - 如果之不存在，并且传入的操作为空，则抛出 NPE
 - orElseThrow
```
public T orElseThrow()
```
 如果包裹里的值存在，则返回该值，否则抛出 NoSuchElementException
 
 Returns:
 
 返回一个不为 null 的包裹里的值
 
 Throws:
 
 NoSuchElementException - 如果包裹里的值不存在则抛出该异常
 - orElseThrow
```
public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)
 throws X extends Throwable
```
 如果包裹里的值存在，则返回该值，否则执行传入的操作，获取异常类型的返回值并抛出
 往往是一个包含无参构造器的异常例如传入IllegalStateException::new
 
 Type Parameters:
 
 X - 异常类型
 
 Parameters:
 
 exceptionSupplier - 值不存在时执行的操作，返回值继承 Throwable
 
 Returns:
 
 包裹里不能为空的值
 
 Throws:
 
 X - 如果值不存在
 
 NullPointerException - 如果值不存在并且传入的操作为 null或者操作执行后的返回值为null
 
 X extends Throwable
 - orElseThrow
```
public <X extends Throwable> T orElseThrow(Function<String,? extends X> exceptionFunction,
 String message)
 throws X extends Throwable
```
 如果包裹里的值存在，则返回该值，否则执行传入的操作，获取异常类型的返回值并抛出
 往往是一个包含自定义消息构造器的异常例如
```
 		Opt.ofNullable(null).orElseThrow(IllegalStateException::new, "Ops!Something is wrong!");
 
```
 Type Parameters:
 
 X - 异常类型
 
 Parameters:
 
 exceptionFunction - 值不存在时执行的操作，返回值继承 Throwable
 
 message - 作为传入操作执行时的参数，一般作为异常自定义提示语
 
 Returns:
 
 包裹里不能为空的值
 
 Throws:
 
 X - 如果值不存在
 
 NullPointerException - 如果值不存在并且传入的操作为 null或者操作执行后的返回值为null
 
 X extends Throwable
 - toOptional
```
public Optional<T> toOptional()
```
 转换为 Optional对象
 
 Returns:
 
 Optional对象
 
 Since:
 
 5.7.16
 - equals
```
public boolean equals(Object obj)
```
 判断传入参数是否与 Opt相等在以下情况下返回true
 - 它也是一个 Opt 并且
 - 它们包裹住的元素都为空或者
 - 它们包裹住的元素之间相互 equals()
 Overrides:
 
 equals in class Object
 
 Parameters:
 
 obj - 一个要用来判断是否相等的参数
 
 Returns:
 
 如果传入的参数也是一个 Opt并且它们包裹住的元素都为空或者它们包裹住的元素之间相互 equals() 就返回true 否则返回 false
 - hashCode
```
public int hashCode()
```
 如果包裹内元素为空，则返回0，否则返回元素的 hashcode
 
 Overrides:
 
 hashCode in class Object
 
 Returns:
 
 如果包裹内元素为空，则返回0，否则返回元素的 hashcode
 - toString
```
public String toString()
```
 返回包裹内元素调用toString()的结果，不存在则返回null
 
 Overrides:
 
 toString in class Object
 
 Returns:
 
 包裹内元素调用toString()的结果，不存在则返回null

Class Opt<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

empty

of

ofNullable

ofBlankAble

ofEmptyAble

ofTry

get

isEmpty

getException

isFail

ifFail

isPresent

ifPresent

ifPresentOrElse

mapOrElse

filter

map

flatMap

flattedMap

peek

peeks

or

stream

orElse

exceptionOrElse

orElseGet

orElseThrow

orElseThrow

orElseThrow

toOptional

equals

hashCode

toString