com.jcabi.aspects

Annotation Type RetryOnFailure

@Documented
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface RetryOnFailure

Retry the method in case of exception.

For example, this load() method will retry to load the URL content if it fails at the first attempts:

 @RetryOnFailure(attempts = 2)
 String load(URL url) throws IOException {
   return url.getContent().toString();
 }

Since:

0.1.10

Version:

$Id: 65f12bbf5ae83a722a1c651ef0ac0ba0abd6f4c1 $

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

http://aspects.jcabi.com/

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	attempts How many times to retry.
long	delay Delay between attempts, in time units.
Class<? extends Throwable>[]	ignore Exception types to ignore.
boolean	randomize Shall the time between retries by randomized.
Class<? extends Throwable>[]	types When to retry (in case of what exception types).
TimeUnit	unit Time units.
boolean	verbose Shall it be fully verbose (show full exception trace) or just exception message?

Element Detail

attempts

public abstract int attempts

How many times to retry.

Suppressed Checkstyle violations:

MagicNumber (2 lines)

Default:

3

delay

public abstract long delay

Delay between attempts, in time units.

Suppressed Checkstyle violations:

MagicNumber (2 lines)

Default:

50L

unit

public abstract TimeUnit unit

Time units.

Default:

java.util.concurrent.TimeUnit.MILLISECONDS

types

public abstract Class<? extends Throwable>[] types

When to retry (in case of what exception types).

Default:

java.lang.Throwable.class

ignore

public abstract Class<? extends Throwable>[] ignore

Exception types to ignore.

Default:

{}

verbose

public abstract boolean verbose

Shall it be fully verbose (show full exception trace) or just exception message?

Default:

true

randomize

public abstract boolean randomize

Shall the time between retries by randomized.

Default:

true