ReactiveBlockingException (Hookless 0.16.1 API)

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.machinezoo.hookless.ReactiveBlockingException

All Implemented Interfaces:: Serializable

public class ReactiveBlockingException extends RuntimeException

Default exception to throw when reactive code needs to reactively block.

Merely creating or throwing this exception is not sufficient to indicate blocking. Current reactive computation must be explicitly marked as blocked before throwing by calling CurrentReactiveScope.block(). This class defines convenience block() method and its overloads that call CurrentReactiveScope.block() before throwing ReactiveBlockingException.

Reactive code should preferably return fallback in case it signals blocking, because that allows the rest of the code to continue and to trigger further blocking operations. This way all blocking operations (e.g. database queries) can execute in parallel.

It is however sometimes impossible to provide a reasonable fallback result. In those cases, throwing an exception is acceptable.

This exception type is provided as the most descriptive for cases of reactive blocking. Its use is not mandatory though. Code that reactively blocks may throw any exception.

See Also:

Constructor Summary

Constructors

Constructor

Description

ReactiveBlockingException()

Constructs new ReactiveBlockingException.

ReactiveBlockingException(String message)

Constructs new ReactiveBlockingException with the specified message.

ReactiveBlockingException(String message, Throwable cause)

Constructs new ReactiveBlockingException with the specified message and cause.

ReactiveBlockingException(Throwable cause)

Constructs new ReactiveBlockingException with the specified cause.
Method Summary

Modifier and Type

Method

Description

static ReactiveBlockingException

block()

Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException.

static ReactiveBlockingException

block(String message)

Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException with the specified message.

static ReactiveBlockingException

block(String message, Throwable cause)

Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException with the specified message and cause.

static ReactiveBlockingException

block(Throwable cause)

Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException with the specified cause.

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

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

Constructor Details
- ReactiveBlockingException
  
  public ReactiveBlockingException(String message, Throwable cause)
  
  Constructs new ReactiveBlockingException with the specified message and cause.
  Merely calling this constructor does not block current ReactiveScope. Use block(String, Throwable) for that.
  Parameters:
  
  message - informative message (possibly null) that can be later retrieved via Throwable.getMessage()
  
  cause - cause of this exception (possibly null) that can be later retrieved via Throwable.getCause()
  
  See Also:
  
  block(String, Throwable)
- ReactiveBlockingException
  
  public ReactiveBlockingException(String message)
  
  Constructs new ReactiveBlockingException with the specified message.
  Merely calling this constructor does not block current ReactiveScope. Use block(String) for that.
  Parameters:
  
  message - informative message (possibly null) that can be later retrieved via Throwable.getMessage()
  
  See Also:
  
  block(String)
- ReactiveBlockingException
  
  public ReactiveBlockingException(Throwable cause)
  
  Constructs new ReactiveBlockingException with the specified cause. If cause is not null, message string of this exception will be set to cause.toString().
  Merely calling this constructor does not block current ReactiveScope. Use block(Throwable) for that.
  Parameters:
  
  cause - cause of this exception (possibly null) that can be later retrieved via Throwable.getCause()
  
  See Also:
  
  block(Throwable)
- ReactiveBlockingException
  
  public ReactiveBlockingException()
  
  Constructs new ReactiveBlockingException. The exception will have no message, i.e. it will return null from Throwable.getMessage().
  Merely calling this constructor does not block current ReactiveScope. Use block() for that.
  See Also:
  
  block()
Method Details
- block
  
  public static ReactiveBlockingException block(String message, Throwable cause)
  
  Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException with the specified message and cause. Current reactive scope is blocked by calling CurrentReactiveScope.block().
  This method always throws and thus never returns. Declared return type is just a convenience that lets callers avoid unreachable code errors by placing the call in a throw statement, e.g. throw ReactiveBlockingException.block(...).
  Parameters:
  
  message - message (possibly null) passed to ReactiveBlockingException(String, Throwable)
  
  cause - cause (possibly null) passed to ReactiveBlockingException(String, Throwable)
  
  Returns:
  
  never returns
  
  See Also:
  
  ReactiveBlockingException(String, Throwable)
- block
  
  public static ReactiveBlockingException block(String message)
  
  Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException with the specified message. Current reactive scope is blocked by calling CurrentReactiveScope.block().
  This method always throws and thus never returns. Declared return type is just a convenience that lets callers avoid unreachable code errors by placing the call in a throw statement, e.g. throw ReactiveBlockingException.block(...).
  Parameters:
  
  message - message (possibly null) passed to ReactiveBlockingException(String)
  
  Returns:
  
  never returns
  
  See Also:
  
  ReactiveBlockingException(String)
- block
  
  public static ReactiveBlockingException block(Throwable cause)
  
  Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException with the specified cause. Current reactive scope is blocked by calling CurrentReactiveScope.block().
  This method always throws and thus never returns. Declared return type is just a convenience that lets callers avoid unreachable code errors by placing the call in a throw statement, e.g. throw ReactiveBlockingException.block(...).
  Parameters:
  
  cause - cause (possibly null) passed to ReactiveBlockingException(Throwable)
  
  Returns:
  
  never returns
  
  See Also:
  
  ReactiveBlockingException(Throwable)
- block
  
  public static ReactiveBlockingException block()
  
  Marks the current ReactiveScope as blocking and then throws ReactiveBlockingException. Current reactive scope is blocked by calling CurrentReactiveScope.block().
  This method always throws and thus never returns. Declared return type is just a convenience that lets callers avoid unreachable code errors by placing the call in a throw statement, e.g. throw ReactiveBlockingException.block(...).
  Returns:
  
  never returns
  
  See Also:
  
  ReactiveBlockingException()

Class ReactiveBlockingException

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Constructor Details

ReactiveBlockingException

ReactiveBlockingException

ReactiveBlockingException

ReactiveBlockingException

Method Details

block

block

block

block