Sf (stream-core 1.4.4 API)

构造器
构造器和说明
`Sf(T value)` `Sf`的构造方法
`Sf(T value, boolean notActive)` Constructor for Sf.

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Sf<T>`	`also(SerCons<T> consumer)` 对当前`Sf`中所包裹对象进行消费操作无返回值，用于操作非`null`，否则抛出NPE如为了保证安全操作可以使用mayAlso
`static <R> Sf<R>`	`empty()` 返回一个空的`Sf`
`T`	`get()` 拿到`Sf`中的数据
`boolean`	`is(SerFunc<T,Boolean> function)` 对当前`Sf`中所包裹对象进行操作返回一个布尔值如果所操作对象不等于`null`并且则判断所传入操作是否返回为true，
`boolean`	`isEmpty()` 判断`Sf`中操作的数据是否为`null`
`boolean`	`isPresent()` 判断`Sf`中操作的数据是否存在
`<R> Sf<R>`	`let(SerFunc<T,R> function)` 对当前`Sf`中所包裹对象进行操作并返回值，返回值会包裹到`Sf`中替换之前的元素，用于操作非`null`，否则抛出NPE如为了保证安全操作可以使用mayLet
`Sf<T>`	`mayAlso(SerCons<T> consumer)` 对当前`Sf`中所包裹对象进行消费操作无返回值，如果所操作对象为`null`则不进行操作
`static <E,T extends Collection<E>> Sf<T>`	`mayColl(T value)` 将集合包裹到Sf中自动过滤掉元素为`null`的
`<R> Sf<R>`	`mayLet(SerFunc<T,R> function)` 对当前`Sf`中所包裹对象进行操作并返回值，返回值会包裹到`Sf`中替换之前的元素如果所操作对象为null则不进行操作
`static <T extends CharSequence> Sf<T>`	`mayStr(T value)` 将传入字符串包裹到Sf中如果为空字符串则过滤掉
`Sf<T>`	`mayTakeIf(SerFunc<T,Boolean> function)` 对当前`Sf`中所包裹对象进行操作并返回一个布尔值，如果当前返回值为false则将Sf中包裹的数据置为`null`返回true则不变，如果所操作对象为`null`则不进行操作
`Sf<T>`	`mayTakeUnless(SerFunc<T,Boolean> function)` 与mayTakeIf相反对当前`Sf`中所包裹对象进行操作并返回一个布尔值，如果当前返回值为true则将Sf中包裹的数据置为`null`返回false则不变，如果所操作对象为`null`则不进行操作
`static <T> Sf<T>`	`of(T value)` 将参数包裹到Sf中,无论参数是否为`null`
`static <E,T extends Collection<E>> Sf<T>`	`ofColl(T value)` 将参数(集合)包裹到Sf中无论是否为`null`
`static <T extends CharSequence> Sf<T>`	`ofStr(T value)` 将传入字符串包裹到Sf中无论是否为`null`
`Sf<T>`	`or(SerSupp<Sf<T>> supplier)` 中间生产者操作，如果当前`Sf`中所包裹元素为`null`则拿到生产者所生产对象包裹到`Sf`中替换原有值，不为`null`则返回`Sf`本身
`T`	`orElse(T other)` 生产者操作，获取当前`Sf`中包裹对象如果当前`Sf`中所包裹元素为`null`则拿到`other`包裹到Sf中替换原有值，不为`Sf`则返回Sf所包裹对象
`T`	`orGet(SerSupp<T> supplier)` 生产者操作，与orElse(T other)区别为自定义产生数据的逻辑操作，返回值定制性更高获取当前`Sf`中包裹对象如果当前`Sf`中所包裹元素为`null`则拿到生产者所生产对象包裹到`Sf`中替换原有值，不为`Sf`则返回Sf所包裹对象
`T`	`orRun(SerRunn mapper)` orRun.
`T`	`orThrow()` 与require()区别为一个是终止操作一个是中间操作默认情况下获取当前`Sf`对象中所包裹的数据如果当前`Sf`中所包裹元素为`null`则抛出NoSuchElementException异常
`<X extends Throwable> T`	`orThrow(SerSupp<X> supplier)` 与require(SerSupplier supplier)区别为一个是终止操作一个是中间操作获取当前`Sf`对象如果当前`Sf`中所包裹元素为`null`则抛出指定异常，不为`null`则返回`Sf`对象所操作数据
`Sf<T>`	`require()` 默认情况下获取当前`Sf`对象如果当前`Sf`中所包裹元素为`null`则抛出NoSuchElementException异常，
`<X extends Throwable> Sf<T>`	`require(SerSupp<X> supplier)` 获取当前`Sf`对象如果当前`Sf`中所包裹元素为`null`则抛出指定异常，不为`null`则返回`Sf`对象（中间操作）
`Sf<T>`	`takeIf(SerFunc<T,Boolean> function)` 对当前`Sf`中所包裹对象进行操作并返回一个布尔值，如果当前返回值为false则将`Sf`中包裹的数据置为`null`返回true则不变，用于操作非`null`，否则抛出NPE如为了保证安全操作可以使用mayTakeIf
`Sf<T>`	`takeUnless(SerFunc<T,Boolean> function)` 与takeIf相反对当前`Sf`中所包裹对象进行操作并返回一个布尔值，如果当前返回值为true则将`Sf`中包裹的数据置为`null`返回false则不变，用于操作非`null`，否则抛出NPE如为了保证安全操作可以使用mayTakeUnless

java.lang.Object
- org.dromara.streamquery.stream.core.optional.Sf<T>

```
public class Sf<T>
extends Object
```
scope-functions

作者:

VampireAchao Cizai_

从以下版本开始:

2022/9/15

另请参阅:

构造器概要

构造器
构造器和说明

Sf(T value)
Sf的构造方法

Sf(T value, boolean notActive)
Constructor for Sf.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型方法和说明

Sf<T> also(SerCons<T> consumer)
对当前Sf中所包裹对象进行消费操作无返回值，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayAlso

static <R> Sf<R> empty()
返回一个空的Sf

T get()
拿到Sf中的数据

boolean is(SerFunc<T,Boolean> function)
对当前Sf中所包裹对象进行操作返回一个布尔值如果所操作对象不等于null并且则判断所传入操作是否返回为true，

boolean isEmpty()
判断Sf中操作的数据是否为null

boolean isPresent()
判断Sf中操作的数据是否存在

<R> Sf<R> let(SerFunc<T,R> function)
对当前Sf中所包裹对象进行操作并返回值，返回值会包裹到Sf中替换之前的元素，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayLet

Sf<T> mayAlso(SerCons<T> consumer)
对当前Sf中所包裹对象进行消费操作无返回值，如果所操作对象为null则不进行操作

static <E,T extends Collection<E>> Sf<T> mayColl(T value)
将集合包裹到Sf中自动过滤掉元素为null的

<R> Sf<R> mayLet(SerFunc<T,R> function)
对当前Sf中所包裹对象进行操作并返回值，返回值会包裹到Sf中替换之前的元素如果所操作对象为null则不进行操作

static <T extends CharSequence> Sf<T> mayStr(T value)
将传入字符串包裹到Sf中如果为空字符串则过滤掉

Sf<T> mayTakeIf(SerFunc<T,Boolean> function)
对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为false则将Sf中包裹的数据置为null返回true则不变，如果所操作对象为null则不进行操作

Sf<T> mayTakeUnless(SerFunc<T,Boolean> function)
与mayTakeIf相反对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为true则将Sf中包裹的数据置为null返回false则不变，如果所操作对象为null则不进行操作

static <T> Sf<T> of(T value)
将参数包裹到Sf中,无论参数是否为null

static <E,T extends Collection<E>> Sf<T> ofColl(T value)
将参数(集合)包裹到Sf中无论是否为null

static <T extends CharSequence> Sf<T> ofStr(T value)
将传入字符串包裹到Sf中无论是否为null

Sf<T> or(SerSupp<Sf<T>> supplier)
中间生产者操作，如果当前Sf中所包裹元素为null则拿到生产者所生产对象包裹到Sf中替换原有值，不为null则返回Sf本身

T orElse(T other)
生产者操作，获取当前Sf中包裹对象如果当前Sf中所包裹元素为null则拿到other包裹到Sf中替换原有值，不为Sf则返回Sf所包裹对象

T orGet(SerSupp<T> supplier)
生产者操作，与orElse(T other)区别为自定义产生数据的逻辑操作，返回值定制性更高获取当前Sf中包裹对象如果当前Sf中所包裹元素为null则拿到生产者所生产对象包裹到Sf中替换原有值，不为Sf则返回Sf所包裹对象

T orRun(SerRunn mapper)
orRun.

T orThrow()
与require()区别为一个是终止操作一个是中间操作默认情况下获取当前Sf对象中所包裹的数据如果当前Sf中所包裹元素为null则抛出NoSuchElementException异常

<X extends Throwable> T orThrow(SerSupp<X> supplier)
与require(SerSupplier supplier)区别为一个是终止操作一个是中间操作获取当前Sf对象如果当前Sf中所包裹元素为null则抛出指定异常，不为null则返回Sf对象所操作数据

Sf<T> require()
默认情况下获取当前Sf对象如果当前Sf中所包裹元素为null则抛出NoSuchElementException异常，

<X extends Throwable> Sf<T> require(SerSupp<X> supplier)
获取当前Sf对象如果当前Sf中所包裹元素为null则抛出指定异常，不为null则返回Sf对象（中间操作）

Sf<T> takeIf(SerFunc<T,Boolean> function)
对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为false则将Sf中包裹的数据置为null返回true则不变，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayTakeIf

Sf<T> takeUnless(SerFunc<T,Boolean> function)
与takeIf相反对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为true则将Sf中包裹的数据置为null返回false则不变，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayTakeUnless

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Sf
```
public Sf(T value)
```
    Sf的构造方法
    
    参数:
    
    value - Sf中要操作的数据
  - Sf
```
public Sf(T value,
          boolean notActive)
```
    Constructor for Sf.
    
    参数:
    
    value - a T object
    
    notActive - a boolean
- 方法详细资料
  - of
```
public static <T> Sf<T> of(T value)
```
    将参数包裹到Sf中,无论参数是否为null
    
    类型参数:
    
    T - a T class
    
    参数:
    
    value - 包裹的值
    
    返回:
    
    Sf<T>
  - ofColl
```
public static <E,T extends Collection<E>> Sf<T> ofColl(T value)
```
    将参数(集合)包裹到Sf中无论是否为null
    
    类型参数:
    
    E - a E class
    
    T - a T class
    
    参数:
    
    value - 包裹的集合
    
    返回:
    
    Sf<T>
  - mayColl
```
public static <E,T extends Collection<E>> Sf<T> mayColl(T value)
```
    将集合包裹到Sf中自动过滤掉元素为null的
    
    类型参数:
    
    E - a E class
    
    T - a T class
    
    参数:
    
    value - 包裹的集合
    
    返回:
    
    Sf<T>
  - ofStr
```
public static <T extends CharSequence> Sf<T> ofStr(T value)
```
    将传入字符串包裹到Sf中无论是否为null
    
    类型参数:
    
    T - a T class
    
    参数:
    
    value - 包裹的字符串
    
    返回:
    
    Sf<T>
  - mayStr
```
public static <T extends CharSequence> Sf<T> mayStr(T value)
```
    将传入字符串包裹到Sf中如果为空字符串则过滤掉
    
    类型参数:
    
    T - a T class
    
    参数:
    
    value - 包裹的字符串
    
    返回:
    
    Sf<T>
  - empty
```
public static <R> Sf<R> empty()
```
    返回一个空的Sf
    
    类型参数:
    
    R - a R class
    
    返回:
    
    Sf<R>
  - isEmpty
```
public boolean isEmpty()
```
    判断Sf中操作的数据是否为null
    
    返回:
    
    boolean 为null返回true 否则false
  - isPresent
```
public boolean isPresent()
```
    判断Sf中操作的数据是否存在
    
    返回:
    
    boolean 存在返回true 否则false
  - get
```
public T get()
```
    拿到Sf中的数据
    
    返回:
    
    T
  - let
```
public <R> Sf<R> let(SerFunc<T,R> function)
```
    对当前Sf中所包裹对象进行操作并返回值，返回值会包裹到Sf中替换之前的元素，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayLet
    
    类型参数:
    
    R - a R class
    
    参数:
    
    function - 执行的操作
    
    返回:
    
    Sf<R>
  - mayLet
```
public <R> Sf<R> mayLet(SerFunc<T,R> function)
```
    对当前Sf中所包裹对象进行操作并返回值，返回值会包裹到Sf中替换之前的元素如果所操作对象为null则不进行操作
    
    类型参数:
    
    R - a R class
    
    参数:
    
    function - 值存在时执行的操作
    
    返回:
    
    Sf<R>
  - also
```
public Sf<T> also(SerCons<T> consumer)
```
    对当前Sf中所包裹对象进行消费操作无返回值，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayAlso
    
    参数:
    
    consumer - 执行的操作
    
    返回:
    
    Sf<T>
  - mayAlso
```
public Sf<T> mayAlso(SerCons<T> consumer)
```
    对当前Sf中所包裹对象进行消费操作无返回值，如果所操作对象为null则不进行操作
    
    参数:
    
    consumer - 值存在时执行的操作
    
    返回:
    
    Sf<T>
  - takeIf
```
public Sf<T> takeIf(SerFunc<T,Boolean> function)
```
    对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为false则将Sf中包裹的数据置为null返回true则不变，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayTakeIf
    
    参数:
    
    function - 执行的操作
    
    返回:
    
    Sf<T>
  - mayTakeIf
```
public Sf<T> mayTakeIf(SerFunc<T,Boolean> function)
```
    对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为false则将Sf中包裹的数据置为null返回true则不变，如果所操作对象为null则不进行操作
    
    参数:
    
    function - 值存在时执行的操作
    
    返回:
    
    Sf<T>
  - takeUnless
```
public Sf<T> takeUnless(SerFunc<T,Boolean> function)
```
    与takeIf相反对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为true则将Sf中包裹的数据置为null返回false则不变，用于操作非null，否则抛出NPE如为了保证安全操作可以使用mayTakeUnless
    
    参数:
    
    function - 执行的操作
    
    返回:
    
    Sf<T>
  - mayTakeUnless
```
public Sf<T> mayTakeUnless(SerFunc<T,Boolean> function)
```
    与mayTakeIf相反对当前Sf中所包裹对象进行操作并返回一个布尔值，如果当前返回值为true则将Sf中包裹的数据置为null返回false则不变，如果所操作对象为null则不进行操作
    
    参数:
    
    function - 值存在时执行的操作
    
    返回:
    
    Sf<T>
  - is
```
public boolean is(SerFunc<T,Boolean> function)
```
    对当前Sf中所包裹对象进行操作返回一个布尔值如果所操作对象不等于null并且则判断所传入操作是否返回为true，
    
    参数:
    
    function - 执行的操作
    
    返回:
    
    boolean 如果等于null则返回false，如果操作不为null，那么操作返回true则为true，返回false则为false
  - require
```
public <X extends Throwable> Sf<T> require(SerSupp<X> supplier)
                                    throws X extends Throwable
```
    获取当前Sf对象如果当前Sf中所包裹元素为null则抛出指定异常，不为null则返回Sf对象（中间操作）
    
    类型参数:
    
    X - a X class
    
    参数:
    
    supplier - 操作
    
    返回:
    
    Sf<T>
    
    抛出:
    
    X - 如果给定的操作为 null，抛出指定异常
    
    X extends Throwable
  - require
```
public Sf<T> require()
```
    默认情况下获取当前Sf对象如果当前Sf中所包裹元素为null则抛出NoSuchElementException异常，
    
    返回:
    
    Sf<T>
  - or
```
public Sf<T> or(SerSupp<Sf<T>> supplier)
```
    中间生产者操作，如果当前Sf中所包裹元素为null则拿到生产者所生产对象包裹到Sf中替换原有值，不为null则返回Sf本身
    
    参数:
    
    supplier - 操作
    
    返回:
    
    Sf<T>
  - orElse
```
public T orElse(T other)
```
    生产者操作，获取当前Sf中包裹对象如果当前Sf中所包裹元素为null则拿到other包裹到Sf中替换原有值，不为Sf则返回Sf所包裹对象
    
    参数:
    
    other - 产生的值
    
    返回:
    
    T
  - orGet
```
public T orGet(SerSupp<T> supplier)
```
    生产者操作，与orElse(T other)区别为自定义产生数据的逻辑操作，返回值定制性更高获取当前Sf中包裹对象如果当前Sf中所包裹元素为null则拿到生产者所生产对象包裹到Sf中替换原有值，不为Sf则返回Sf所包裹对象
    
    参数:
    
    supplier - 生产者操作
    
    返回:
    
    T
  - orRun
```
public T orRun(SerRunn mapper)
```
    orRun.
    
    参数:
    
    mapper - a SerRunn object
    
    返回:
    
    a T object
  - orThrow
```
public <X extends Throwable> T orThrow(SerSupp<X> supplier)
                                throws X extends Throwable
```
    与require(SerSupplier supplier)区别为一个是终止操作一个是中间操作获取当前Sf对象如果当前Sf中所包裹元素为null则抛出指定异常，不为null则返回Sf对象所操作数据
    
    类型参数:
    
    X - a X class
    
    参数:
    
    supplier - 操作
    
    返回:
    
    T
    
    抛出:
    
    X - 如果给定的操作为 null，抛出指定异常
    
    X extends Throwable
  - orThrow
```
public T orThrow()
```
    与require()区别为一个是终止操作一个是中间操作默认情况下获取当前Sf对象中所包裹的数据如果当前Sf中所包裹元素为null则抛出NoSuchElementException异常
    
    返回:
    
    T Sf对象中所包裹的数据

类 Sf<T>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Sf

Sf

方法详细资料

of

ofColl

mayColl

ofStr

mayStr

empty

isEmpty

isPresent

get

let

mayLet

also

mayAlso

takeIf

mayTakeIf

takeUnless

mayTakeUnless

is

require

require

or

orElse

orGet

orRun

orThrow

orThrow