net.jodah.recurrent

Class Invocation

java.lang.Object

net.jodah.recurrent.RetryStats

net.jodah.recurrent.Invocation

public class Invocation
extends RetryStats

An invocation that accepts retry and completion requests.

Method Summary

Modifier and Type	Method and Description
void	complete() Completes the associated RecurrentFuture.
boolean	complete(Object result) Completes the associated RecurrentFuture with the result.
boolean	complete(Object result, Throwable failure) Completes the associated RecurrentFuture with the result and failure.
boolean	completeExceptionally(Throwable failure) Completes the associated RecurrentFuture with the failure.
boolean	retry() Retries a failed invocation.
boolean	retryOn(Throwable failure) Retries a failed invocation.
boolean	retryWhen(Object result) Retries a failed invocation.
boolean	retryWhen(Object result, Throwable failure) Retries a failed invocation.

Methods inherited from class net.jodah.recurrent.RetryStats

canRetryOn, canRetryWhen, canRetryWhen, getRetryCount, getWaitTime

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

complete

public void complete()

Completes the associated RecurrentFuture.

Throws:

IllegalStateException - if a complete method has already been called

complete

public boolean complete(Object result)

Completes the associated RecurrentFuture with the result. Returns true on success, else false if completion failed and should be retried via retryWhen(Object).

Throws:

IllegalStateException - if a complete method has already been called

completeExceptionally

public boolean completeExceptionally(Throwable failure)

Completes the associated RecurrentFuture with the failure. Returns true on success, else false if completion failed and should be retried via RetryStats.canRetryOn(Throwable).

Throws:

IllegalStateException - if a complete method has already been called

complete

public boolean complete(Object result,
                        Throwable failure)

Completes the associated RecurrentFuture with the result and failure. Returns true on success, else false if completion failed and should be retried via RetryStats.canRetryWhen(Object, Throwable).

Throws:

IllegalStateException - if a complete method has already been called

retry

public boolean retry()

Retries a failed invocation. Returns true if the retry can be attempted, else returns false and completes the associated RecurrentFuture exceptionally if the retry policy has been exceeded.

Throws:

IllegalStateException - if a retry method has already been called

retryOn

public boolean retryOn(Throwable failure)

Retries a failed invocation. Returns true if the retry can be attempted for the failure, else returns false and completes the associated RecurrentFuture exceptionally if the retry policy has been exceeded.

Throws:

NullPointerException - if failure is null

IllegalStateException - if a retry method has already been called

retryWhen

public boolean retryWhen(Object result)

Retries a failed invocation. Returns true if the retry can be attempted for the result, else returns false and completes the associated RecurrentFuture exceptionally if the retry policy has been exceeded.

Throws:

NullPointerException - if result is null

IllegalStateException - if a retry method has already been called

retryWhen

public boolean retryWhen(Object result,
                         Throwable failure)

Retries a failed invocation. Returns true if the retry can be attempted for the result and failure, else returns false and completes the associated RecurrentFuture exceptionally if the retry policy has been exceeded.

Throws:

IllegalArgumentException - if result and failure are both null

IllegalStateException - if a retry method has already been called