Package org.kiwiproject.retry

Class KiwiRetryerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.kiwiproject.retry.KiwiRetryerException

All Implemented Interfaces:

Serializable

public class KiwiRetryerException
extends RuntimeException

Exception thrown by KiwiRetryer.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
KiwiRetryerException(String message, Throwable cause)	Construct an instance with the given information.

Method Summary

Modifier and Type	Method	Description
Optional<Throwable>	unwrap()	Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.
Optional<Throwable>	unwrapFully()	Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.
static Optional<Throwable>	unwrapKiwiRetryerException(KiwiRetryerException kiwiRetryerEx)	Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.
static Optional<Throwable>	unwrapKiwiRetryerExceptionFully(KiwiRetryerException kiwiRetryerEx)	Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.

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

KiwiRetryerException

public KiwiRetryerException(String message,
                            Throwable cause)

Construct an instance with the given information.

Parameters:

message - the detail message

cause - the (non-null) cause of the failure

Method Detail

unwrapKiwiRetryerException

public static Optional<Throwable> unwrapKiwiRetryerException(KiwiRetryerException kiwiRetryerEx)

Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.

If the given exception is an ExecutionException (i.e. something bad and unexpected occurred during the retry attempts) then its cause will be returned. Otherwise return the direct cause, which is most likely a RetryException.

Since it is possible for an attempt to fail without an exception, or for an ExecutionException to have a null cause, this method returns an Optional to indicate there might not actually be an exception cause.

Parameters:

kiwiRetryerEx - the exception to unwrap

Returns:

the unwrapped cause

See Also:

unwrapKiwiRetryerExceptionFully(KiwiRetryerException)

unwrapKiwiRetryerExceptionFully

public static Optional<Throwable> unwrapKiwiRetryerExceptionFully(KiwiRetryerException kiwiRetryerEx)

Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.

If the given exception is an ExecutionException (i.e. something bad and unexpected occurred during the retry attempts) then its cause will be returned. If it is a RetryException, then unwrap it and return its cause.

The difference between unwrapKiwiRetryerException(KiwiRetryerException) and this method and is that the former does not unwrap the RetryException, whereas the latter (this method) does.

Since it is possible for an attempt to fail without an exception, or for an ExecutionException to have a null cause, this method returns an Optional to indicate there might not actually be an exception cause.

Parameters:

kiwiRetryerEx - the exception to unwrap

Returns:

the fully unwrapped cause

unwrap

public Optional<Throwable> unwrap()

Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.

Returns:

the unwrapped cause

See Also:

unwrapKiwiRetryerException(KiwiRetryerException), unwrapFully()

unwrapFully

public Optional<Throwable> unwrapFully()

Unwrap the given KiwiRetryerException to reveal the underlying exception that caused it.

Returns:

the fully unwrapped cause

See Also:

unwrapKiwiRetryerExceptionFully(KiwiRetryerException)