Index (Recurrent 0.7.1 API)

A B C D E F G I L N O P R S T W

A

abortIf(BiPredicate<T, ? extends Throwable>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that retries should be aborted if the completionPredicate matches the completion result.
abortIf(Predicate<T>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that retries should be aborted if the resultPredicate matches the result.
abortOn(Class<? extends Throwable>...) - Method in class net.jodah.recurrent.RetryPolicy: Specifies when retries should be aborted.
abortOn(List<Class<? extends Throwable>>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies when retries should be aborted.
abortOn(Predicate<? extends Throwable>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that retries should be aborted if the failurePredicate matches the failure.
abortWhen(Object) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that retries should be aborted if the execution result matches the result.
allowsRetries() - Method in class net.jodah.recurrent.RetryPolicy: Returns whether the policy allows any retries based on the configured maxRetries and maxDuration.
allowsRetriesFor(Object, Throwable) - Method in class net.jodah.recurrent.RetryPolicy: Returns whether the policy will allow retries for the failure.
AsyncCallable<T> - Interface in net.jodah.recurrent: A callable that manually triggers asynchronous retries or completion.
AsyncExecution - Class in net.jodah.recurrent: Tracks asynchronous executions and allows retries to be scheduled according to a RetryPolicy.
AsyncListeners<T> - Class in net.jodah.recurrent: Recurrent event listeners that are called asynchronously on the Scheduler or ScheduledExecutorService associated with the Recurrent call.
AsyncListeners() - Constructor for class net.jodah.recurrent.AsyncListeners
AsyncRecurrent - Class in net.jodah.recurrent: Performs asynchronous executions with retries according to a RetryPolicy.
AsyncRunnable - Interface in net.jodah.recurrent: A runnable that manually triggers asynchronous retries or completion.

B

BiPredicate<T,U> - Interface in net.jodah.recurrent.util

C

call(AsyncExecution) - Method in interface net.jodah.recurrent.AsyncCallable
call(ExecutionStats) - Method in interface net.jodah.recurrent.ContextualCallable
cancel(boolean) - Method in class net.jodah.recurrent.RecurrentFuture
cancel(boolean) - Method in class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture
canRetryFor(Object) - Method in class net.jodah.recurrent.Execution: Returns true if a retry can be performed for the result, else returns false and completes the execution.
canRetryFor(Object, Throwable) - Method in class net.jodah.recurrent.Execution: Returns true if a retry can be performed for the result or failure, else returns false and completes the execution.
canRetryOn(Throwable) - Method in class net.jodah.recurrent.Execution: Returns true if a retry can be performed for the failure, else returns false and completes the execution.
CheckedRunnable - Interface in net.jodah.recurrent: A Runnable that throws checked exceptions.
compareTo(Delayed) - Method in class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture
complete() - Method in class net.jodah.recurrent.AsyncExecution: Completes the execution and the associated RecurrentFuture.
complete(Object) - Method in class net.jodah.recurrent.AsyncExecution: Attempts to complete the execution and the associated RecurrentFuture with the result.
complete(Object, Throwable) - Method in class net.jodah.recurrent.AsyncExecution: Attempts to complete the execution and the associated RecurrentFuture with the result and failure.
complete() - Method in class net.jodah.recurrent.Execution: Completes the execution.
complete(Object) - Method in class net.jodah.recurrent.Execution: Attempts to complete the execution with the result.
ContextualCallable<T> - Interface in net.jodah.recurrent: A callable that provides contextual execution statistics.
ContextualResultListener<R,F extends Throwable> - Interface in net.jodah.recurrent.event: Listens for an execution result, providing ExecutionStats that describe executions so far.
ContextualRunnable - Interface in net.jodah.recurrent: A runnable that provides contextual execution statistics.
ContextualSuccessListener<R> - Interface in net.jodah.recurrent.event: Listens for an execution success, providing ExecutionStats that describe executions so far.
copy() - Method in class net.jodah.recurrent.RetryPolicy: Returns a copy of this RetryPolicy.

D

DefaultScheduledFuture<T> - Class in net.jodah.recurrent.util.concurrent: A default ScheduledFuture implementation.
DefaultScheduledFuture() - Constructor for class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture
Duration - Class in net.jodah.recurrent.util: Duration unit, consisting of length and time unit.
Duration(long, TimeUnit) - Constructor for class net.jodah.recurrent.util.Duration

E

Execution - Class in net.jodah.recurrent: Tracks executions and determines when an execution can be performed for a RetryPolicy.
Execution(RetryPolicy) - Constructor for class net.jodah.recurrent.Execution: Creates a new Execution for the retryPolicy.
ExecutionStats - Class in net.jodah.recurrent: Execution statistics.

F

fail(Throwable) - Method in class net.jodah.recurrent.Execution: Fails the execution attempt and returns true if a retry can be performed for the failure, else returns false and completes the execution.
future(Callable<CompletableFuture<T>>) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.
future(ContextualCallable<CompletableFuture<T>>) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.
futureAsync(AsyncCallable<CompletableFuture<T>>) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the callable asynchronously until the resulting future is successfully completed or the configured RetryPolicy is exceeded.

G

get(Callable<T>) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.
get(ContextualCallable<T>) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.
get() - Method in class net.jodah.recurrent.RecurrentFuture
get(long, TimeUnit) - Method in class net.jodah.recurrent.RecurrentFuture
get(Callable<T>) - Method in class net.jodah.recurrent.SyncRecurrent: Executes the callable until a successful result is returned or the configured RetryPolicy is exceeded.
get(ContextualCallable<T>) - Method in class net.jodah.recurrent.SyncRecurrent: Executes the callable until a successful result is returned or the configured RetryPolicy is exceeded.
get() - Method in class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture
get(long, TimeUnit) - Method in class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture
getAsync(AsyncCallable<T>) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the callable asynchronously until a successful result is returned or the configured RetryPolicy is exceeded.
getDelay() - Method in class net.jodah.recurrent.RetryPolicy: Returns the delay between retries.
getDelay(TimeUnit) - Method in class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture
getDelayMultiplier() - Method in class net.jodah.recurrent.RetryPolicy: Returns the delay multiplier for backoff retries.
getElapsedMillis() - Method in class net.jodah.recurrent.ExecutionStats: Returns the elapsed time in milliseconds.
getElapsedNanos() - Method in class net.jodah.recurrent.ExecutionStats: Returns the elapsed time in nanoseconds.
getExecutions() - Method in class net.jodah.recurrent.ExecutionStats: Gets the number of executions so far.
getLastFailure() - Method in class net.jodah.recurrent.Execution: Returns the last failure that was recorded.
getLastResult() - Method in class net.jodah.recurrent.Execution: Returns the last result that was recorded.
getMaxDelay() - Method in class net.jodah.recurrent.RetryPolicy: Returns the max delay between backoff retries.
getMaxDuration() - Method in class net.jodah.recurrent.RetryPolicy: Returns the max duration to perform retries for.
getMaxRetries() - Method in class net.jodah.recurrent.RetryPolicy: Returns the max retries.
getStartMillis() - Method in class net.jodah.recurrent.ExecutionStats: Returns the start time in milliseconds.
getStartNanos() - Method in class net.jodah.recurrent.ExecutionStats: Returns the start time in nanoseconds.
getWaitMillis() - Method in class net.jodah.recurrent.Execution: Returns the wait time in milliseconds.
getWaitNanos() - Method in class net.jodah.recurrent.Execution: Returns the wait time in nanoseconds.

I

isCancelled() - Method in class net.jodah.recurrent.RecurrentFuture
isCancelled() - Method in class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture
isComplete() - Method in class net.jodah.recurrent.Execution: Returns whether the execution is complete.
isDone() - Method in class net.jodah.recurrent.RecurrentFuture
isDone() - Method in class net.jodah.recurrent.util.concurrent.DefaultScheduledFuture

L

length - Variable in class net.jodah.recurrent.util.Duration
Listeners<T> - Class in net.jodah.recurrent: Recurrent event listeners.
Listeners() - Constructor for class net.jodah.recurrent.Listeners

N

net.jodah.recurrent - package net.jodah.recurrent
net.jodah.recurrent.event - package net.jodah.recurrent.event
net.jodah.recurrent.util - package net.jodah.recurrent.util
net.jodah.recurrent.util.concurrent - package net.jodah.recurrent.util.concurrent
NONE - Static variable in class net.jodah.recurrent.util.Duration

O

of(ScheduledExecutorService) - Static method in class net.jodah.recurrent.util.concurrent.Schedulers: Returns a Scheduler adapted from the executor.
onComplete(T, Throwable) - Method in class net.jodah.recurrent.Listeners: Called when an execution is completed.
onComplete(T, Throwable, ExecutionStats) - Method in class net.jodah.recurrent.Listeners: Called when an execution is completed.
onFailedAttempt(T, Throwable) - Method in class net.jodah.recurrent.Listeners: Called after a failed attempt.
onFailedAttempt(T, Throwable, ExecutionStats) - Method in class net.jodah.recurrent.Listeners: Called after a failed attempt.
onFailure(T, Throwable) - Method in class net.jodah.recurrent.Listeners: Called after the retry policy is exceeded and the result is a failure.
onFailure(T, Throwable, ExecutionStats) - Method in class net.jodah.recurrent.Listeners: Called after the retry policy is exceeded and the result is a failure.
onResult(R, F, ExecutionStats) - Method in interface net.jodah.recurrent.event.ContextualResultListener: Handles an execution result.
onResult(R, F) - Method in interface net.jodah.recurrent.event.ResultListener: Handles an execution result.
onRetry(T, Throwable) - Method in class net.jodah.recurrent.Listeners: Called before a retry is attempted.
onRetry(T, Throwable, ExecutionStats) - Method in class net.jodah.recurrent.Listeners: Called before a retry is attempted.
onSuccess(R, ExecutionStats) - Method in interface net.jodah.recurrent.event.ContextualSuccessListener: Handles the successful completion of a call.
onSuccess(R) - Method in interface net.jodah.recurrent.event.SuccessListener: Handles the successful completion of a call.
onSuccess(T) - Method in class net.jodah.recurrent.Listeners: Called after a successful execution.
onSuccess(T, ExecutionStats) - Method in class net.jodah.recurrent.Listeners: Called after a successful execution.

P

Predicate<T> - Interface in net.jodah.recurrent.util

R

Recurrent<T> - Class in net.jodah.recurrent: Performs executions with synchronous or asynchronous retries according to a RetryPolicy.
Recurrent() - Constructor for class net.jodah.recurrent.Recurrent
RecurrentException - Exception in net.jodah.recurrent: Thrown when a synchronous Recurrent run() call fails with an exception.
RecurrentFuture<T> - Class in net.jodah.recurrent: A future result of an asynchronous operation.
ResultListener<R,F extends Throwable> - Interface in net.jodah.recurrent.event: Listens for an execution result.
retry() - Method in class net.jodah.recurrent.AsyncExecution: Attempts to retry a failed execution.
retryFor(Object) - Method in class net.jodah.recurrent.AsyncExecution: Attempts to retry a failed execution.
retryFor(Object, Throwable) - Method in class net.jodah.recurrent.AsyncExecution: Attempts to retry a failed execution.
retryIf(BiPredicate<T, ? extends Throwable>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that a retry should occur if the completionPredicate matches the completion result and the retry policy is not exceeded.
retryIf(Predicate<T>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that a retry should occur if the resultPredicate matches the result and the retry policy is not exceeded.
retryOn(Throwable) - Method in class net.jodah.recurrent.AsyncExecution: Attempts to retry a failed execution.
retryOn(Class<? extends Throwable>...) - Method in class net.jodah.recurrent.RetryPolicy: Specifies the failures to retry on.
retryOn(List<Class<? extends Throwable>>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies the failures to retry on.
retryOn(Predicate<? extends Throwable>) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that a retry should occur if the failurePredicate matches the failure and the retry policy is not exceeded.
RetryPolicy - Class in net.jodah.recurrent: A policy that defines when retries should be performed.
RetryPolicy() - Constructor for class net.jodah.recurrent.RetryPolicy: Creates a retry policy that always retries with no delay.
RetryPolicy(RetryPolicy) - Constructor for class net.jodah.recurrent.RetryPolicy: Copy constructor.
retryWhen(Object) - Method in class net.jodah.recurrent.RetryPolicy: Specifies that a retry should occur if the execution result matches the result and the retry policy is not exceeded.
run(CheckedRunnable) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.
run(ContextualRunnable) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.
run(AsyncExecution) - Method in interface net.jodah.recurrent.AsyncRunnable
run() - Method in interface net.jodah.recurrent.CheckedRunnable
run(ExecutionStats) - Method in interface net.jodah.recurrent.ContextualRunnable
run(CheckedRunnable) - Method in class net.jodah.recurrent.SyncRecurrent: Executes the runnable until successful or until the configured RetryPolicy is exceeded.
run(ContextualRunnable) - Method in class net.jodah.recurrent.SyncRecurrent: Executes the runnable until successful or until the configured RetryPolicy is exceeded.
runAsync(AsyncRunnable) - Method in class net.jodah.recurrent.AsyncRecurrent: Executes the runnable asynchronously until successful or until the configured RetryPolicy is exceeded.

S

schedule(Callable<?>, long, TimeUnit) - Method in interface net.jodah.recurrent.util.concurrent.Scheduler: Schedules the callable to be called after the delay for the unit.
Scheduler - Interface in net.jodah.recurrent.util.concurrent: Schedules executions.
Schedulers - Class in net.jodah.recurrent.util.concurrent: Scheduler utilities.
SuccessListener<R> - Interface in net.jodah.recurrent.event: Listens for an execution success.
SyncRecurrent - Class in net.jodah.recurrent: Performs synchronous executions with retries according to a RetryPolicy.

T

test(T, U) - Method in interface net.jodah.recurrent.util.BiPredicate
test(T) - Method in interface net.jodah.recurrent.util.Predicate
timeUnit - Variable in class net.jodah.recurrent.util.Duration
toNanos() - Method in class net.jodah.recurrent.util.Duration

W

whenComplete(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called when an execution is completed.
whenComplete(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called when an execution is completed.
whenComplete(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called when an execution is completed.
whenComplete(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called when an execution is completed.
whenCompleteAsync(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when an execution is completed.
whenCompleteAsync(ContextualResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when an execution is completed.
whenCompleteAsync(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when an execution is completed.
whenCompleteAsync(ResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when an execution is completed.
whenFailedAttempt(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called after a failed execution attempt.
whenFailedAttempt(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called after a failed execution attempt.
whenFailedAttemptAsync(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously after a failed execution attempt.
whenFailedAttemptAsync(ContextualResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously on the executor after a failed execution attempt.
whenFailedAttemptAsync(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously after a failed execution attempt.
whenFailedAttemptAsync(ResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously on the executor after a failed execution attempt.
whenFailure(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called when the retry policy is exceeded and the result is a failure.
whenFailure(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called when the retry policy is exceeded and the result is a failure.
whenFailure(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called when the retry policy is exceeded and the result is a failure.
whenFailure(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called when the retry policy is exceeded and the result is a failure.
whenFailureAsync(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when the retry policy is exceeded and the result is a failure.
whenFailureAsync(ContextualResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when the retry policy is exceeded and the result is a failure.
whenFailureAsync(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when the retry policy is exceeded and the result is a failure.
whenFailureAsync(ResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously when the retry policy is exceeded and the result is a failure.
whenRetry(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called before a retry is attempted.
whenRetry(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called before a retry is attempted.
whenRetryAsync(ContextualResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously before a retry is attempted.
whenRetryAsync(ContextualResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously on the executor before a retry is attempted.
whenRetryAsync(ResultListener<? super T, ? extends Throwable>) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously before a retry is attempted.
whenRetryAsync(ResultListener<? super T, ? extends Throwable>, ExecutorService) - Method in class net.jodah.recurrent.AsyncListeners: Registers the listener to be called asynchronously on the executor before a retry is attempted.
whenSuccess(ContextualSuccessListener<? super T>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called after a successful execution.
whenSuccess(SuccessListener<? super T>) - Method in class net.jodah.recurrent.Listeners: Registers the listener to be called after a successful execution.
whenSuccess(ContextualSuccessListener<? super T>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called after a successful execution.
whenSuccess(SuccessListener<? super T>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called after a successful execution.
whenSuccessAsync(ContextualSuccessListener<? super T>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously after a successful execution.
whenSuccessAsync(ContextualSuccessListener<? super T>, ExecutorService) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously after a successful execution.
whenSuccessAsync(SuccessListener<? super T>) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously after a successful execution.
whenSuccessAsync(SuccessListener<? super T>, ExecutorService) - Method in class net.jodah.recurrent.RecurrentFuture: Registers the listener to be called asynchronously after a successful execution.
with(T) - Method in class net.jodah.recurrent.AsyncRecurrent: Configures the listeners to be called as execution events occur.
with(RetryPolicy) - Static method in class net.jodah.recurrent.Recurrent: Creates and returns a new SyncRecurrent instance that will perform executions and retries synchronously according to the retryPolicy.
with(RetryPolicy, ScheduledExecutorService) - Static method in class net.jodah.recurrent.Recurrent: Creates and returns a new AsyncRecurrent instance that will perform executions and retries asynchronously via the executor according to the retryPolicy.
with(RetryPolicy, Scheduler) - Static method in class net.jodah.recurrent.Recurrent: Creates and returns a new AsyncRecurrent instance that will perform executions and retries asynchronously via the scheduler according to the retryPolicy.
with(Listeners<?>) - Method in class net.jodah.recurrent.SyncRecurrent: Configures the listeners to be called as execution events occur.
withBackoff(long, long, TimeUnit) - Method in class net.jodah.recurrent.RetryPolicy: Sets the delay between retries, exponentially backing of to the maxDelay and multiplying successive delays by a factor of 2.
withBackoff(long, long, TimeUnit, double) - Method in class net.jodah.recurrent.RetryPolicy: Sets the delay between retries, exponentially backing of to the maxDelay and multiplying successive delays by the delayMultiplier.
withDelay(long, TimeUnit) - Method in class net.jodah.recurrent.RetryPolicy: Sets the delay between retries.
withMaxDuration(long, TimeUnit) - Method in class net.jodah.recurrent.RetryPolicy: Sets the max duration to perform retries for.
withMaxRetries(int) - Method in class net.jodah.recurrent.RetryPolicy: Sets the max number of retries to perform.

A B C D E F G I L N O P R S T W