net.openhft.chronicle.core.threads

Class InvalidEventHandlerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.openhft.chronicle.core.threads.InvalidEventHandlerException

All Implemented Interfaces:

Serializable

public class InvalidEventHandlerException
extends Exception

Represents an exception that is thrown when an event handler is invalid or needs to be removed from an event loop.

This exception class also provides a reusable static instance which is unmodifiable and does not contain any stack trace information. This reusable instance can be used for flow-control purposes such as signalling that an event handler should be removed from the event loop due to successful completion.

It is important to note that the reusable instance should not be used where error information or stack traces are needed, as it doesn't provide these details.

See Also:

reusable(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidEventHandlerException() Constructs a new exception with no detail message.
InvalidEventHandlerException(String message) Constructs a new exception with the specified detail message.
InvalidEventHandlerException(Throwable cause) Constructs a new exception with the specified cause.

Method Summary

Modifier and Type	Method and Description
static InvalidEventHandlerException	reusable() Returns a reusable, pre-created, InvalidEventHandlerException that is unmodifiable and contains no stack trace.

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 Detail

InvalidEventHandlerException

public InvalidEventHandlerException(String message)

Constructs a new exception with the specified detail message.

Parameters:

message - the detail message

InvalidEventHandlerException

public InvalidEventHandlerException()

Constructs a new exception with no detail message.

InvalidEventHandlerException

public InvalidEventHandlerException(Throwable cause)

Constructs a new exception with the specified cause.

Parameters:

cause - the cause

Method Detail

reusable

public static InvalidEventHandlerException reusable()

Returns a reusable, pre-created, InvalidEventHandlerException that is unmodifiable and contains no stack trace.

This is useful for situations where throwing an InvalidEventHandlerException is used strictly for flow-control (e.g. removing an EventHandler from an EventLoop when the former has completed with no errors).

Note that this reusable instance contains no stack trace information and should not be used in scenarios where error information is necessary.

Returns:

a reusable, pre-created, InvalidEventHandlerException that is unmodifiable and contains no stack trace