net.jodah.recurrent

Class Invocation

java.lang.Object

net.jodah.recurrent.Invocation

All Implemented Interfaces:

InvocationStats

Direct Known Subclasses:

AsyncInvocation

public class Invocation
extends Object
implements InvocationStats

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) 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.
int	getAttemptCount() Gets the number of invocation attempts so far.
long	getElapsedMillis() Returns the elapsed time in milliseconds.
long	getElapsedNanos() Returns the elapsed time in nanoseconds.
<T extends Throwable> T	getLastFailure() Returns the last failure that was recorded.
<T> T	getLastResult() Returns the last result that was recorded.
long	getStartMillis() Returns the start time in milliseconds.
long	getStartNanos() Returns the start time in nanoseconds.
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 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)

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

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.

Specified by:

getAttemptCount in interface InvocationStats

getElapsedMillis

public long getElapsedMillis()

Returns the elapsed time in milliseconds.

Specified by:

getElapsedMillis in interface InvocationStats

getElapsedNanos

public long getElapsedNanos()

Returns the elapsed time in nanoseconds.

Specified by:

getElapsedNanos in interface InvocationStats

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)

getStartMillis

public long getStartMillis()

Returns the start time in milliseconds.

Specified by:

getStartMillis in interface InvocationStats

getStartNanos

public long getStartNanos()

Returns the start time in nanoseconds.

Specified by:

getStartNanos in interface InvocationStats

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