de.skuzzle.inject.async

Interface ScheduledContext

public interface ScheduledContext

Holds contextual information about a scheduled method. Any behavior is undefined when methods on this object are called outside the scope of a scheduled method. Custom TriggerStrategy implementations need to take care of supporting the scheduled context theirself.

An instance of this class is available for injection. It is bound as scoped proxy and can thus also be injected into singletons. However, calling methods on the proxy'ed context will only work if the context is active for the current thread.

Since:

0.3.0

Author:

Simon Taddiken

See Also:

ScheduledScope, RunnableBuilder

Method Summary

Modifier and Type	Method and Description
void	beginNewExecution() Records the start of a new execution performed in the current thread.
void	cancel(boolean mayInterrupt) Cancels this scheduled method.
void	finishExecution() Detaches the ExecutionContext from the current thread and thus closes the current execution scope.
ExecutionContext	getExecution() Gets the current execution context.
int	getExecutionCount() Gets the number of times that this method has been executed.
Method	getMethod() Gets the scheduled method to which this scope belongs.
Map<String,Object>	getProperties() Gets the properties that are attached to this context.
boolean	isCancelled() Returns true if cancel has been called on this context.
void	setFuture(Future<?> future) Sets the Future object for controlling the scheduled task.

Method Detail

getMethod

Method getMethod()

Gets the scheduled method to which this scope belongs.

Returns:

The method.

beginNewExecution

void beginNewExecution()

Records the start of a new execution performed in the current thread. Opens up a new ExecutionContext which will be attached to the current thread until finishExecution() is called.

See Also:

ExecutionScope

finishExecution

void finishExecution()

Detaches the ExecutionContext from the current thread and thus closes the current execution scope. Must be called from within the same thread from which beginNewExecution() has been called in order to close the correct context.

See Also:

ExecutionScope

getProperties

Map<String,Object> getProperties()

Gets the properties that are attached to this context. This map is also used by the ScheduledScope implementation to store cached objects.

Returns:

The context properties.

getExecutionCount

int getExecutionCount()

Gets the number of times that this method has been executed. Note: the value might be out of date by the time it is returned. You might want to use ExecutionContext.getExecutionNr() to figure out the number of the current execution.

Since version 1.1.0 this number no longer denotes the number of times that the method had finished executing. It now returns the number of times that the method has been called, disregarding whether all calls have already returned.

Returns:

The number of times this method has been called.

getExecution

ExecutionContext getExecution()

Gets the current execution context. This will yield a new object for every time the method is scheduled again.

Returns:

The execution context.

cancel

void cancel(boolean mayInterrupt)

Cancels this scheduled method. The method will never be scheduled again on the current instance after this method has been called. Current executions will be interrupted if the flag is passed.

In case the scheduled method is not contained in a singleton scoped object it will be scheduled again once another instance of the object has been created. If the scheduled method was a static one, it will never be scheduled again.

Parameters:

mayInterrupt - Whether running executions may be interrupted.

Since:

0.4.0

isCancelled

boolean isCancelled()

Returns true if cancel has been called on this context.

Returns:

Whether this scheduled method has been cancelled.

Since:

0.4.0

setFuture

void setFuture(Future<?> future)

Sets the Future object for controlling the scheduled task. Should only be called by TriggerStrategy implementations to make the context support the cancel(boolean) method. If no Future object is set by the strategy, canceling will not be possible.

Parameters:

future - The Future object obtained from the scheduler.

Since:

0.4.0