Module kivakit.core

Package com.telenav.kivakit.core.thread

Class Retry

java.lang.Object

com.telenav.kivakit.core.messaging.broadcasters.Multicaster

com.telenav.kivakit.core.messaging.repeaters.BaseRepeater

com.telenav.kivakit.core.thread.Retry

All Implemented Interfaces:

Broadcaster, Listener, Repeater, Transceiver, Receiver, Transmitter, NamedObject

public class Retry
extends BaseRepeater

Retry running a Runnable

Author:

matthieun, jonathanl

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAXIMUM_NUMBER_RETRIES

Constructor Summary

Constructors

Constructor	Description
Retry(Listener listener)	A basic Retry that does not wait before retrying and catches all Throwable errors.
Retry(Listener listener, int numberOfRetries, Duration retryWaitDuration, Class<? extends Throwable> exceptionType, String... exceptionMessageExclusion)	A retry tool to run a Runnable as long as there is one type of exception

Method Summary

Modifier and Type	Method	Description
static <T> UncheckedCode<T>	retry(UncheckedCode<T> code, int times, Duration delay, Runnable... beforeRetry)
<T> T	run(UncheckedCode<T> runnable, Runnable... stepsBeforeRetry)	Run a Runnable and retry as long as the exception type defined is thrown

Methods inherited from class com.telenav.kivakit.core.messaging.repeaters.BaseRepeater

onMessage, onReceive

Methods inherited from class com.telenav.kivakit.core.messaging.broadcasters.Multicaster

addListener, clearListeners, debugClassContext, debugCodeContext, debugCodeContext, hasListeners, isDeaf, isTransmitting, listenerChain, listeners, listenerTree, messageSource, messageSource, objectName, removeListener, transmit, withoutTransmitting

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.telenav.kivakit.core.messaging.Broadcaster

addListener, addListener, clearListeners, copyListeners, hasListeners, listeners, messageSource, messageSource, onTransmit, onTransmitted, onTransmitting, removeListener, silence, transmit, transmit, transmitAll

Methods inherited from interface com.telenav.kivakit.core.messaging.Listener

isDeaf, listenTo, listenTo

Methods inherited from interface com.telenav.kivakit.interfaces.naming.NamedObject

hasSyntheticName, objectName, objectName

Methods inherited from interface com.telenav.kivakit.interfaces.messaging.Receiver

isReceiving

Methods inherited from interface com.telenav.kivakit.core.messaging.Repeater

isRepeating, receive

Methods inherited from interface com.telenav.kivakit.core.messaging.Transceiver

announce, debug, debugClassContext, debugCodeContext, debugCodeContext, fatal, fatal, glitch, glitch, glitch, glitch, halted, halted, ifDebug, illegalArgument, illegalState, illegalState, information, isDebugOn, narrate, problem, problem, problem, problem, problemIfNull, quibble, quibble, quibble, quibble, trace, trace, trace, trace, warning, warning, warning, warning

Methods inherited from interface com.telenav.kivakit.interfaces.messaging.Transmitter

isTransmitting, withoutTransmitting

Field Details

MAXIMUM_NUMBER_RETRIES

public static final int MAXIMUM_NUMBER_RETRIES

See Also:

• Constant Field Values

Constructor Details

Retry

public Retry(Listener listener)

A basic Retry that does not wait before retrying and catches all Throwable errors.

Retry

public Retry(Listener listener,
 int numberOfRetries,
 Duration retryWaitDuration,
 Class<? extends Throwable> exceptionType,
 String... exceptionMessageExclusion)

A retry tool to run a Runnable as long as there is one type of exception

Parameters:

listener - Listener for the broadcasts

numberOfRetries - The number of failures allowed

retryWaitDuration - The duration to wait between retries

exceptionType - The type of exception to be caught. It needs to be a type that extends Throwable

exceptionMessageExclusion - An arbitrary number of Strings. If the exception caught has a message that contains one of the Strings contained in this set, the exception will be thrown and no retry will be made.

Method Details

retry

public static <T> UncheckedCode<T> retry(UncheckedCode<T> code,
 int times,
 Duration delay,
 Runnable... beforeRetry)

run

public <T> T run(UncheckedCode<T> runnable,
 Runnable... stepsBeforeRetry)

Run a Runnable and retry as long as the exception type defined is thrown

Parameters:

runnable - The runnable to be tried

stepsBeforeRetry - This is an optional list of steps executed in case the try fails, and right before each retry