reactor.core.util

Enum Exceptions

java.lang.Object

java.lang.Enum<Exceptions>

reactor.core.util.Exceptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Exceptions>

public enum Exceptions
extends java.lang.Enum<Exceptions>

Static Helpers to decorate an error with an associated data

Since:

2.0

See Also:

Reactive-Streams-Commons

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Exceptions.AlertException Used to alert consumers waiting with a WaitStrategy for status changes.
static class	Exceptions.CancelException An error signal from downstream subscribers consuming data when their state is denying any additional event.
static class	Exceptions.DownstreamException An exception that is propagated downward through Subscriber.onError(Throwable)
static class	Exceptions.InsufficientCapacityException Exception thrown when the it is not possible to dispatch a signal due to insufficient capacity.
static class	Exceptions.ReactiveException An exception helper for lambda and other checked-to-unchecked exception wrapping
static class	Exceptions.UpstreamException An exception that is propagated upward and considered as "fatal" as per Reactive Stream limited list of exceptions allowed to bubble.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Throwable	TERMINATED A singleton instance of a Throwable indicating a terminal state for exceptions, don't leak this!

Method Summary

Modifier and Type	Method and Description
static <T> boolean	addThrowable(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,java.lang.Throwable> field, T instance, java.lang.Throwable exception) Signal a desynchronization of demand and timer.
static java.lang.NullPointerException	argumentIsNullException()
static java.lang.RuntimeException	bubble(java.lang.Throwable t) Return an unchecked RuntimeException to be thrown that will bubble upstream.
static java.lang.IllegalStateException	duplicateOnSubscribeException()
static Exceptions.CancelException	failWithCancel() Return a Exceptions.CancelException
static Exceptions.InsufficientCapacityException	failWithOverflow() Return an Exceptions.InsufficientCapacityException
static java.lang.IllegalArgumentException	nullOrNegativeRequestException(long elements)
static void	onErrorDropped(java.lang.Throwable e) Take an unsignalled exception that is masking anowher one due to callback failure.
static void	onErrorDropped(java.lang.Throwable e, java.lang.Throwable root) Take an unsignalled exception that is masking anowher one due to callback failure.
static <T> void	onNextDropped(T t) An unexpected event is about to be dropped.
static java.lang.RuntimeException	propagate(java.lang.Throwable t) Return an unchecked RuntimeException to be thrown that will be propagated downstream through Subscriber.onError(Throwable).
static <T> java.lang.Throwable	terminate(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,java.lang.Throwable> field, T instance) Atomic utility to safely mark a volatile throwable reference with a terminal marker.
static void	throwIfFatal(java.lang.Throwable t) Throws a particular Throwable only if it belongs to a set of "fatal" error varieties.
static java.lang.Throwable	unwrap(java.lang.Throwable t) Unwrap a particular Throwable only if it is a wrapped UpstreamException or DownstreamException
static Exceptions	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Exceptions[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TERMINATED

public static final java.lang.Throwable TERMINATED

A singleton instance of a Throwable indicating a terminal state for exceptions, don't leak this!

Method Detail

values

public static Exceptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Exceptions c : Exceptions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Exceptions valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

addThrowable

public static <T> boolean addThrowable(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,java.lang.Throwable> field,
                                       T instance,
                                       java.lang.Throwable exception)

Signal a desynchronization of demand and timer.

Type Parameters:

T - the parent instance type

Parameters:

field - the target field updater

instance - the parent instance for the field

exception - the Throwable to add.

Returns:

true if added, false if the field contained the TERMINATED instance.

argumentIsNullException

public static java.lang.NullPointerException argumentIsNullException()

Returns:

a new NullPointerException with a cause message abiding to reactive stream specification.

duplicateOnSubscribeException

public static java.lang.IllegalStateException duplicateOnSubscribeException()

Returns:

a new IllegalStateException with a cause message abiding to reactive stream specification.

propagate

public static java.lang.RuntimeException propagate(java.lang.Throwable t)

Return an unchecked RuntimeException to be thrown that will be propagated downstream through Subscriber.onError(Throwable).

This method invokes throwIfFatal(Throwable).

Parameters:

t - the root cause

Returns:

an unchecked exception

bubble

public static java.lang.RuntimeException bubble(java.lang.Throwable t)

Return an unchecked RuntimeException to be thrown that will bubble upstream.

This method invokes throwIfFatal(Throwable).

Parameters:

t - the root cause

Returns:

an unchecked exception that should choose bubbling up over error callback path

failWithCancel

public static Exceptions.CancelException failWithCancel()

Return a Exceptions.CancelException

Returns:

a Exceptions.CancelException

failWithOverflow

public static Exceptions.InsufficientCapacityException failWithOverflow()

Return an Exceptions.InsufficientCapacityException

Returns:

an Exceptions.InsufficientCapacityException

nullOrNegativeRequestException

public static java.lang.IllegalArgumentException nullOrNegativeRequestException(long elements)

Parameters:

elements - the invalid requested demand

Returns:

a new IllegalArgumentException with a cause message abiding to reactive stream specification.

onErrorDropped

public static void onErrorDropped(java.lang.Throwable e,
                                  java.lang.Throwable root)

Take an unsignalled exception that is masking anowher one due to callback failure.

Parameters:

e - the exception to handle

root - the optional root cause to suppress

onErrorDropped

public static void onErrorDropped(java.lang.Throwable e)

Take an unsignalled exception that is masking anowher one due to callback failure.

Parameters:

e - the exception to handle

onNextDropped

public static <T> void onNextDropped(T t)

An unexpected event is about to be dropped.

Type Parameters:

T - the dropped value type

Parameters:

t - the dropping data

terminate

public static <T> java.lang.Throwable terminate(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,java.lang.Throwable> field,
                                                T instance)

Atomic utility to safely mark a volatile throwable reference with a terminal marker.

Type Parameters:

T - the instance type

Parameters:

field - the atomic container

instance - the reference instance

Returns:

the previously masked throwable

throwIfFatal

public static void throwIfFatal(java.lang.Throwable t)

Throws a particular Throwable only if it belongs to a set of "fatal" error varieties. These varieties are as follows:

• Exceptions.UpstreamException
• StackOverflowError
• VirtualMachineError
• ThreadDeath
• LinkageError

Parameters:

t - the exception to evaluate

unwrap

public static java.lang.Throwable unwrap(java.lang.Throwable t)

Unwrap a particular Throwable only if it is a wrapped UpstreamException or DownstreamException

Parameters:

t - the exception to wrap

Returns:

the unwrapped exception