org.arp.javautil.io

Class Retryer<E>

java.lang.Object

org.arp.javautil.io.Retryer<E>

Type Parameters:

E - the type of error code or exception that occurs when the operation fails.

public class Retryer<E>
extends Object

Retries a data access operation whose failure is expected under defined circumstances. This enables fault tolerance.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
Retryer(int retries) Constructs a retryer with a number of retries.

Method Summary

Modifier and Type	Method and Description
boolean	execute(Retryable<E> operation) Executes a command with retries retries.
int	getAttempts() Gets the number of attempts that have been made to execute the Retryable from the most recent call to execute(org.arp.javautil.io.Retryable).
List<E>	getErrors() Returns any error codes or exceptions from the most recent call to execute(org.arp.javautil.io.Retryable).
int	getRetries() Gets the number of times that execute(org.arp.javautil.io.Retryable) will retry the operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Retryer

public Retryer(int retries)

Constructs a retryer with a number of retries.

Parameters:

retries - the number of retries.

Method Detail

getRetries

public int getRetries()

Gets the number of times that execute(org.arp.javautil.io.Retryable) will retry the operation.

Returns:

the number of retries.

getAttempts

public int getAttempts()

Gets the number of attempts that have been made to execute the Retryable from the most recent call to execute(org.arp.javautil.io.Retryable).

Returns:

the number of attempts.

getErrors

public List<E> getErrors()

Returns any error codes or exceptions from the most recent call to execute(org.arp.javautil.io.Retryable). The number of codes is equal to the number of failures, and the codes are returned in order.

Returns:

a newly created List of errors.

execute

public boolean execute(Retryable<E> operation)

Executes a command with retries retries. This can be executed multiple times.

Parameters:

operation - the operation to attempt.

Returns:

true if the operation succeeded, false if not. Consult getErrors() for any error codes or exceptions that the operation returned.