net.jodah.recurrent

Class Invocation

java.lang.Object

net.jodah.recurrent.Invocation

Direct Known Subclasses:

AsyncInvocation

public class Invocation
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	completed
protected Throwable	lastFailure
protected Object	lastResult

Constructor Summary

Constructors

Constructor and Description
Invocation(RetryPolicy 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) Returns true if a retry can be performed for the result or failure, else returns false and records and completes the invocation.
int	getAttemptCount() Gets the number of invocation attempts so far.
<T extends Throwable> T	getLastFailure() Returns the last failure that was recorded.
<T> T	getLastResult() Returns the last result that was recorded.
long	getWaitTime() 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 java.lang.Object

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

Field Detail

lastResult

protected volatile Object lastResult

lastFailure

protected volatile Throwable lastFailure

completed

protected volatile boolean completed

Constructor Detail

Invocation

public Invocation(RetryPolicy retryPolicy)

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:

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)

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

Throws:

IllegalStateException - if the invocation is already complete

getAttemptCount

public int getAttemptCount()

Gets the number of invocation attempts so far. Invocation attempts are recorded when canRetry is called or when the invocation is completed successfully.

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)

getWaitTime

public long getWaitTime()

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