Sinks.EmitResult (reactor-3)

java.lang.Object
- java.lang.Enum<Sinks.EmitResult>
- - reactor.core.publisher.Sinks.EmitResult

所有已实现的接口:

java.io.Serializable, java.lang.Comparable<Sinks.EmitResult>

封闭类:

Sinks
```
public static enum Sinks.EmitResult
extends java.lang.Enum<Sinks.EmitResult>
```
Represents the immediate result of an emit attempt (eg. in Sinks.Many.tryEmitNext(Object). This does not guarantee that a signal is consumed, it simply refers to the sink state when an emit method is invoked. This is a particularly important distinction with regard to FAIL_CANCELLED which means the sink is -now- interrupted and emission can't proceed. Consequently, it is possible to emit a signal and obtain an "OK" status even if an in-flight cancellation is happening. This is due to the async nature of these actions: producer emits while consumer can interrupt independently.

枚举常量概要

枚举常量
枚举常量和说明
`FAIL_CANCELLED` Has failed to emit the signal because the sink was previously interrupted by its consumer
`FAIL_NON_SERIALIZED` Has failed to emit the signal because the access was not serialized
`FAIL_OVERFLOW` Has failed to emit the signal because the sink does not have buffering capacity left
`FAIL_TERMINATED` Has failed to emit the signal because the sink was previously terminated successfully or with an error
`FAIL_ZERO_SUBSCRIBER` Has failed to emit the signal because the sink has never been subscribed to has no capacity to buffer the signal.
`OK` Has successfully emitted the signal

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`isFailure()` Represents a failure to emit a signal.
`boolean`	`isSuccess()` Represents a successful emission of a signal.
`void`	`orThrow()` Easily convert from an `Sinks.EmitResult` to throwing an exception on `failure cases`.
`void`	`orThrowWithCause(java.lang.Throwable cause)` Easily convert from an `Sinks.EmitResult` to throwing an exception on `failure cases`.
`static Sinks.EmitResult`	`valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static Sinks.EmitResult[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 枚举常量详细资料
  - OK
```
public static final Sinks.EmitResult OK
```
    Has successfully emitted the signal
  - FAIL_TERMINATED
```
public static final Sinks.EmitResult FAIL_TERMINATED
```
    Has failed to emit the signal because the sink was previously terminated successfully or with an error
  - FAIL_OVERFLOW
```
public static final Sinks.EmitResult FAIL_OVERFLOW
```
    Has failed to emit the signal because the sink does not have buffering capacity left
  - FAIL_CANCELLED
```
public static final Sinks.EmitResult FAIL_CANCELLED
```
    Has failed to emit the signal because the sink was previously interrupted by its consumer
  - FAIL_NON_SERIALIZED
```
public static final Sinks.EmitResult FAIL_NON_SERIALIZED
```
    Has failed to emit the signal because the access was not serialized
  - FAIL_ZERO_SUBSCRIBER
```
public static final Sinks.EmitResult FAIL_ZERO_SUBSCRIBER
```
    Has failed to emit the signal because the sink has never been subscribed to has no capacity to buffer the signal.
- 方法详细资料
  - values
```
public static Sinks.EmitResult[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (Sinks.EmitResult c : Sinks.EmitResult.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static Sinks.EmitResult valueOf(java.lang.String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    java.lang.IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    java.lang.NullPointerException - 如果参数为空值
  - isSuccess
```
public boolean isSuccess()
```
    Represents a successful emission of a signal.
    This is more future-proof than checking for equality with OK since new OK-like codes could be introduced later.
  - isFailure
```
public boolean isFailure()
```
    Represents a failure to emit a signal.
  - orThrow
```
public void orThrow()
```
    Easily convert from an Sinks.EmitResult to throwing an exception on failure cases. This is useful if throwing is the most relevant way of dealing with a failed emission attempt. Note however that generally Reactor code doesn't favor throwing exceptions but rather propagating them through onError signals. See also orThrowWithCause(Throwable) in case of an emitError failure for which you want to attach the originally pushed Exception.
    
    另请参阅:
    
    orThrowWithCause(Throwable)
  - orThrowWithCause
```
public void orThrowWithCause(java.lang.Throwable cause)
```
    Easily convert from an Sinks.EmitResult to throwing an exception on failure cases. This is useful if throwing is the most relevant way of dealing with failed tryEmitError attempt, in which case you probably wants to propagate the originally pushed Exception. Note however that generally Reactor code doesn't favor throwing exceptions but rather propagating them through onError signals.
    
    另请参阅:
    
    orThrow()

枚举 Sinks.EmitResult

枚举常量概要

方法概要

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

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

枚举常量详细资料

OK

FAIL_TERMINATED

FAIL_OVERFLOW

FAIL_CANCELLED

FAIL_NON_SERIALIZED

FAIL_ZERO_SUBSCRIBER

方法详细资料

values

valueOf

isSuccess

isFailure

orThrow

orThrowWithCause