org.spf4j.base

Class Callables

java.lang.Object

org.spf4j.base.Callables

@ParametersAreNonnullByDefault
public final class Callables
extends Object

Utility class for executing stuff with retry logic.

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Callables.AdvancedAction Deprecated. use RetryPolicy
static interface	Callables.AdvancedRetryPredicate<T> Deprecated. use RetryPolicy
static interface	Callables.CheckedCallable<T,EX extends Exception> A callable that will be retried.
static class	Callables.FibonacciBackoffRetryPredicate<T,R> Deprecated. use RetryPolicy
static class	Callables.RetryDecision<R> Deprecated. use RetryPolicy
static interface	Callables.RetryPredicate<T,R> Deprecated. use RetryPolicy
static class	Callables.SimpleAction Deprecated. use RetryPolicy
static interface	Callables.SimpleRetryPredicate<T> Deprecated. use RetryPolicy
static class	Callables.TimeoutCallable<T,EX extends Exception> Deprecated. use RetryPolicy
static interface	Callables.TimeoutRetryPredicate<T,R> Deprecated. use RetryPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static Callables.AdvancedRetryPredicate<Exception>	DEFAULT_EXCEPTION_RETRY Deprecated. use RetryPolicy
static Predicate<Exception>	DEFAULT_EXCEPTION_RETRY_PREDICATE Deprecated. use RetryPolicy
static Callables.SimpleRetryPredicate<?>	RETRY_FOR_NULL_RESULT Deprecated. use RetryPolicy

Method Summary

Modifier and Type	Method and Description
static <V> Callable<V>	constant(V value)
static <T,EX extends Exception> T	executeWithRetry(Callables.CheckedCallable<T,EX> pwhat, Callables.RetryPredicate<? super T,T> retryOnReturnVal, Callables.RetryPredicate<Exception,T> retryOnException, Class<EX> exceptionClass) Deprecated. use RetryPolicy
static <T,EX extends Exception> T	executeWithRetry(Callables.TimeoutCallable<T,EX> what, Callables.TimeoutRetryPredicate<? super T,T> retryOnReturnVal, Callables.TimeoutRetryPredicate<Exception,T> retryOnException, Class<EX> exceptionClass) Deprecated. use RetryPolicy
static <T,EX extends Exception> T	executeWithRetry(Callables.TimeoutCallable<T,EX> what, Callables.TimeoutRetryPredicate<Exception,T> retryOnException, Class<EX> exceptionClass) Deprecated. use RetryPolicy
static <T,EX extends Exception> T	executeWithRetry(Callables.TimeoutCallable<T,EX> what, int nrImmediateRetries, int maxRetryWaitMillis, Callables.AdvancedRetryPredicate<Exception> retryOnException, Class<EX> exceptionClass) Deprecated. use RetryPolicy
static <T,EX extends Exception> T	executeWithRetry(Callables.TimeoutCallable<T,EX> what, int nrImmediateRetries, int maxWaitMillis, Callables.TimeoutRetryPredicate<? super T,T> retryOnReturnVal, Callables.AdvancedRetryPredicate<Exception> retryOnException, Class<EX> exceptionClass) Deprecated. use RetryPolicy
static <T,EX extends Exception> T	executeWithRetry(Callables.TimeoutCallable<T,EX> what, int nrImmediateRetries, int maxRetryWaitMillis, Class<EX> exceptionClass) Deprecated. use RetryPolicy
static <T> T	executeWithRetry(Callables.TimeoutCallable<T,RuntimeException> what, int nrImmediateRetries, int maxRetryWaitMillis) Deprecated. use RetryPolicy
static <T> T	executeWithRetry(Callables.TimeoutCallable<T,RuntimeException> what, int nrImmediateRetries, int maxRetryWaitMillis, Callables.AdvancedRetryPredicate<Exception> retryOnException) Deprecated. use RetryPolicy
static Callable<Void>	from(Runnable value)
static <V> Callable<V>	memorized(Callable<V> source)
static Class	rootClass(Exception f) Deprecated. use RetryPolicy
static <T> Callable<T>	synchronize(Callable<T> callable)
static <T> Callable<T>	withName(Callable<T> callable, String name) This is a duplicate of guava Callables.threadRenaming ...

Methods inherited from class java.lang.Object

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

Field Detail

RETRY_FOR_NULL_RESULT

@Deprecated
public static final Callables.SimpleRetryPredicate<?> RETRY_FOR_NULL_RESULT

Deprecated. use RetryPolicy

DEFAULT_EXCEPTION_RETRY

@Deprecated
public static final Callables.AdvancedRetryPredicate<Exception> DEFAULT_EXCEPTION_RETRY

Deprecated. use RetryPolicy

DEFAULT_EXCEPTION_RETRY_PREDICATE

@Deprecated
public static final Predicate<Exception> DEFAULT_EXCEPTION_RETRY_PREDICATE

Deprecated. use RetryPolicy

Method Detail

executeWithRetry

@Deprecated
 @Nullable
public static <T,EX extends Exception> T executeWithRetry(Callables.TimeoutCallable<T,EX> what,
                                                                                 int nrImmediateRetries,
                                                                                 int maxRetryWaitMillis,
                                                                                 Class<EX> exceptionClass)
                                                                          throws InterruptedException,
                                                                                 EX extends Exception,
                                                                                 TimeoutException

Deprecated. use RetryPolicy

Throws:

InterruptedException

EX extends Exception

TimeoutException

executeWithRetry

@Deprecated
 @Nullable
public static <T> T executeWithRetry(Callables.TimeoutCallable<T,RuntimeException> what,
                                                            int nrImmediateRetries,
                                                            int maxRetryWaitMillis)
                                                     throws InterruptedException,
                                                            TimeoutException

Deprecated. use RetryPolicy

Throws:

InterruptedException

TimeoutException

executeWithRetry

@Deprecated
 @Nullable
public static <T,EX extends Exception> T executeWithRetry(Callables.TimeoutCallable<T,EX> what,
                                                                                 int nrImmediateRetries,
                                                                                 int maxRetryWaitMillis,
                                                                                 Callables.AdvancedRetryPredicate<Exception> retryOnException,
                                                                                 Class<EX> exceptionClass)
                                                                          throws InterruptedException,
                                                                                 EX extends Exception,
                                                                                 TimeoutException

Deprecated. use RetryPolicy

Throws:

InterruptedException

EX extends Exception

TimeoutException

executeWithRetry

@Deprecated
 @Nullable
public static <T> T executeWithRetry(Callables.TimeoutCallable<T,RuntimeException> what,
                                                            int nrImmediateRetries,
                                                            int maxRetryWaitMillis,
                                                            Callables.AdvancedRetryPredicate<Exception> retryOnException)
                                                     throws InterruptedException,
                                                            TimeoutException

Deprecated. use RetryPolicy

Throws:

InterruptedException

TimeoutException

executeWithRetry

@Deprecated
 @Nullable
public static <T,EX extends Exception> T executeWithRetry(Callables.TimeoutCallable<T,EX> what,
                                                                                 int nrImmediateRetries,
                                                                                 int maxWaitMillis,
                                                                                 Callables.TimeoutRetryPredicate<? super T,T> retryOnReturnVal,
                                                                                 Callables.AdvancedRetryPredicate<Exception> retryOnException,
                                                                                 Class<EX> exceptionClass)
                                                                          throws InterruptedException,
                                                                                 EX extends Exception,
                                                                                 TimeoutException

Deprecated. use RetryPolicy

After the immediate retries are done, delayed retry with randomized Fibonacci values up to the specified max is executed.

Type Parameters:

T - - the type returned by the Callable that is retried.

EX - - the Exception thrown by the retried callable.

Parameters:

what - - the callable to retry.

nrImmediateRetries - - the number of immediate retries.

maxWaitMillis - - maximum wait time in between retries.

retryOnReturnVal - - predicate to control retry on return value;

retryOnException - - predicate to retry on thrown exception.

Returns:

the result of the callable.

Throws:

InterruptedException - - thrown if interrupted.

EX - - the exception declared to be thrown by the callable.

EX extends Exception

TimeoutException

rootClass

@Deprecated
public static Class rootClass(Exception f)

Deprecated. use RetryPolicy

executeWithRetry

@Deprecated
 @Nullable
public static <T,EX extends Exception> T executeWithRetry(Callables.TimeoutCallable<T,EX> what,
                                                                                 Callables.TimeoutRetryPredicate<? super T,T> retryOnReturnVal,
                                                                                 Callables.TimeoutRetryPredicate<Exception,T> retryOnException,
                                                                                 Class<EX> exceptionClass)
                                                                          throws InterruptedException,
                                                                                 EX extends Exception,
                                                                                 TimeoutException

Deprecated. use RetryPolicy

Throws:

InterruptedException

EX extends Exception

TimeoutException

executeWithRetry

@Deprecated
 @Nullable
public static <T,EX extends Exception> T executeWithRetry(Callables.TimeoutCallable<T,EX> what,
                                                                                 Callables.TimeoutRetryPredicate<Exception,T> retryOnException,
                                                                                 Class<EX> exceptionClass)
                                                                          throws InterruptedException,
                                                                                 EX extends Exception,
                                                                                 TimeoutException

Deprecated. use RetryPolicy

Throws:

InterruptedException

EX extends Exception

TimeoutException

executeWithRetry

@Deprecated
 @Nullable
public static <T,EX extends Exception> T executeWithRetry(Callables.CheckedCallable<T,EX> pwhat,
                                                                                 Callables.RetryPredicate<? super T,T> retryOnReturnVal,
                                                                                 Callables.RetryPredicate<Exception,T> retryOnException,
                                                                                 Class<EX> exceptionClass)
                                                                          throws InterruptedException,
                                                                                 TimeoutException,
                                                                                 EX extends Exception

Deprecated. use RetryPolicy

Naive implementation of execution with retry logic. a callable will be executed and retry attempted in current thread if the result and exception predicates. before retry, a callable can be executed that can abort the retry and finish the function with the previous result.

Type Parameters:

T - - The type of callable to retry result;

EX - - the exception thrown by the callable to retry.

Parameters:

pwhat - - the callable to retry.

retryOnReturnVal - - the predicate to control retry on return value.

retryOnException - - the predicate to return on retry value.

Returns:

the result of the retried callable if successful.

Throws:

InterruptedException - - thrown if retry interrupted.

EX - - the exception thrown by callable.

TimeoutException

EX extends Exception

synchronize

public static <T> Callable<T> synchronize(Callable<T> callable)

withName

public static <T> Callable<T> withName(Callable<T> callable,
                                       String name)

This is a duplicate of guava Callables.threadRenaming ... will have to review for deprecation/removal.

memorized

public static <V> Callable<V> memorized(Callable<V> source)

constant

public static <V> Callable<V> constant(V value)

from

public static Callable<Void> from(Runnable value)