net.jodah.recurrent

Class Invocation

java.lang.Object

net.jodah.recurrent.InvocationStats

net.jodah.recurrent.Invocation

Direct Known Subclasses:

AsyncInvocation

public class Invocation
extends InvocationStats

Tracks invocations and determines when an invocation can be performed for a RetryPolicy.

Constructor Summary

Constructors

Constructor and Description
Invocation(RetryPolicy retryPolicy) Creates a new Invocation for the retryPolicy.

Method Summary

Modifier and Type	Method and Description
boolean	canRetryFor(Object result) Returns true if a retry can be performed for the result, else returns false and completes the invocation.
boolean	canRetryFor(Object result, Throwable failure) Returns true if a retry can be performed for the result or failure, else returns false and completes the invocation.
boolean	canRetryOn(Throwable failure) Returns true if a retry can be performed for the failure, else returns false and completes the invocation.
void	complete() Completes the invocation.
boolean	complete(Object result) Attempts to complete the invocation with the result.
<T extends Throwable> T	getLastFailure() Returns the last failure that was recorded.
<T> T	getLastResult() Returns the last result that was recorded.
long	getWaitMillis() Returns the wait time in milliseconds.
long	getWaitNanos() Returns the wait time in nanoseconds.
boolean	isComplete() Returns whether the invocation is complete.
boolean	recordFailure(Throwable failure) Records a failed invocation attempt and returns true if a retry can be performed for the failure, else returns false and completes the invocation.

Methods inherited from class net.jodah.recurrent.InvocationStats

getAttemptCount, getElapsedMillis, getElapsedNanos, getStartMillis, getStartNanos

Methods inherited from class java.lang.Object

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

Constructor Detail

Invocation

public Invocation(RetryPolicy retryPolicy)

Creates a new Invocation for the retryPolicy.

Throws:

NullPointerException - if retryPolicy is null

Method Detail

canRetryFor

public boolean canRetryFor(Object result)

Returns true if a retry can be performed for the result, else returns false and completes the invocation.

Throws:

IllegalStateException - if the invocation is already complete

canRetryFor

public boolean canRetryFor(Object result,
                           Throwable failure)

Returns true if a retry can be performed for the result or failure, else returns false and completes the invocation.

Throws:

IllegalStateException - if the invocation is already complete

canRetryOn

public boolean canRetryOn(Throwable failure)

Returns true if a retry can be performed for the failure, else returns false and completes the invocation.

Throws:

NullPointerException - if failure is null

IllegalStateException - if the invocation is already complete

complete

public void complete()

Completes the invocation.

Throws:

IllegalStateException - if the invocation is already complete

complete

public boolean complete(Object result)

Attempts to complete the invocation with the result. Returns true on success, else false if completion failed and should be retried.

Throws:

IllegalStateException - if the invocation is already complete

getLastFailure

public <T extends Throwable> T getLastFailure()

Returns the last failure that was recorded.

See Also:

recordFailure(Throwable)

getLastResult

public <T> T getLastResult()

Returns the last result that was recorded.

See Also:

complete(), complete(Object)

getWaitMillis

public long getWaitMillis()

Returns the wait time in milliseconds.

getWaitNanos

public long getWaitNanos()

Returns the wait time in nanoseconds.

isComplete

public boolean isComplete()

Returns whether the invocation is complete.

See Also:

complete(), complete(Object), recordFailure(Throwable)

recordFailure

public boolean recordFailure(Throwable failure)

Records a failed invocation attempt and returns true if a retry can be performed for the failure, else returns false and completes the invocation.

Alias of canRetryOn(Throwable)

Throws:

IllegalStateException - if the invocation is already complete