Index (Guice async extension 1.2.0 API)

A B C D E F G H I L M O P R S T V W

A

Async - Annotation Type in de.skuzzle.inject.async.annotation: Tags a method to be run asynchronously.
AsyncModule - Class in de.skuzzle.inject.async.internal: Exposes required bindings.
AsyncModule(GuiceAsync) - Constructor for class de.skuzzle.inject.async.internal.AsyncModule: As GuiceAsync is not instantiatable from outside, the constructor guards this class from being created unintentionally.

B

beginNewExecution() - Method in interface de.skuzzle.inject.async.ScheduledContext: Records the start of a new execution performed in the current thread.

C

call() - Method in class de.skuzzle.inject.async.internal.runnables.InvocationCallable
cancel(boolean) - Method in interface de.skuzzle.inject.async.ScheduledContext: Cancels this scheduled method.
configure() - Method in class de.skuzzle.inject.async.internal.AsyncModule
configure() - Method in class de.skuzzle.inject.async.internal.context.ContextModule
configure() - Method in class de.skuzzle.inject.async.internal.runnables.RunnablesModule
ContextFactory - Interface in de.skuzzle.inject.async.internal.context: Used to create ScheduledContext objects for scheduled methods.
ContextModule - Class in de.skuzzle.inject.async.internal.context: Purely used internal to install context related bindings into the main module.
ContextModule(GuiceAsync) - Constructor for class de.skuzzle.inject.async.internal.context.ContextModule
createContext(Method) - Method in interface de.skuzzle.inject.async.internal.context.ContextFactory: Creates a new ScheduledContext instance which can be used to manage a single scheduled method.
createLockedRunnableStack(InjectedMethodInvocation, ScheduledContext, ExceptionHandler) - Method in interface de.skuzzle.inject.async.internal.runnables.RunnableBuilder: Like RunnableBuilder.createRunnableStack(InjectedMethodInvocation, ScheduledContext, ExceptionHandler) but creates a Runnable which must be released before it is able to be executed.
createModule() - Static method in class de.skuzzle.inject.async.GuiceAsync: Creates a module that can be used to enable asynchronous method support.
createRunnableStack(InjectedMethodInvocation, ScheduledContext, ExceptionHandler) - Method in interface de.skuzzle.inject.async.internal.runnables.RunnableBuilder: Creates a Runnable for running an execution in the scope of a given context and to handle errors with the given ExceptionHandler.
CronTrigger - Annotation Type in de.skuzzle.inject.async.annotation: A trigger annotation for specifying a cron pattern which describes the scheduling of the method.
CronTriggerStrategy - Class in de.skuzzle.inject.async.internal.trigger: TriggerStrategy that handles the CronTrigger annotation.
CronTriggerStrategy() - Constructor for class de.skuzzle.inject.async.internal.trigger.CronTriggerStrategy
CronType - Enum in de.skuzzle.inject.async.annotation: Defines the cron format.

D

de.skuzzle.inject.async - package de.skuzzle.inject.async: Main public API.
de.skuzzle.inject.async.annotation - package de.skuzzle.inject.async.annotation: Contains annotation type for supplying meta information on methods.
de.skuzzle.inject.async.internal - package de.skuzzle.inject.async.internal: Internal implementation which should not be considered part of the public API.
de.skuzzle.inject.async.internal.context - package de.skuzzle.inject.async.internal.context
de.skuzzle.inject.async.internal.runnables - package de.skuzzle.inject.async.internal.runnables
de.skuzzle.inject.async.internal.trigger - package de.skuzzle.inject.async.internal.trigger: Contains trigger implementations for scheduling methods.
de.skuzzle.inject.async.util - package de.skuzzle.inject.async.util: General utilities for asynchronous method executions.
DelayedTrigger - Annotation Type in de.skuzzle.inject.async.annotation: A trigger that will execute a method only once after a certain delay.
DelayedTriggerStrategy - Class in de.skuzzle.inject.async.internal.trigger: Handles the DelayedTrigger.
DelayedTriggerStrategy() - Constructor for class de.skuzzle.inject.async.internal.trigger.DelayedTriggerStrategy
delegate(T) - Static method in class de.skuzzle.inject.async.util.Futures: Returns a dummy Future object to be used to return a value in methods that are annotated with Async.
delegateCompletable(T) - Static method in class de.skuzzle.inject.async.util.Futures: Returns a dummy CompletableFuture object to be used to return a value in methods that are annotated with Async.

E

enableFor(Binder) - Static method in class de.skuzzle.inject.async.GuiceAsync: Enable support for the Async annotation in classes that are used with the injector that will be created from the given Binder.
ExceptionHandler - Interface in de.skuzzle.inject.async: May be used to react to errors thrown from scheduled methods.
ExecutionContext - Interface in de.skuzzle.inject.async: Holds contextual information for a single scheduled method execution.
ExecutionScope - Annotation Type in de.skuzzle.inject.async.annotation: A guice scope that pertains for a single execution of a scheduled method.
Executor - Annotation Type in de.skuzzle.inject.async.annotation: Allows to specify the class part of the Key that is used to look up an ExecutorService for a method annotated with Async.

F

finishExecution() - Method in interface de.skuzzle.inject.async.ScheduledContext: Detaches the ExecutionContext from the current thread and thus closes the current execution scope.
forEachMemberMethod(Class<?>, Consumer<Method>) - Static method in class de.skuzzle.inject.async.util.MethodVisitor: Starting at given type, traverses all super types (except Object.class) and passes each encountered member method (including private ones) to the given consumer.
forEachStaticMethod(Class<?>, Consumer<Method>) - Static method in class de.skuzzle.inject.async.util.MethodVisitor: Starting at given type, traverses all super types (except Object.class) and passes each encountered static method (including private ones) to the given consumer.
forMethod(Method, Object, Injector) - Static method in class de.skuzzle.inject.async.util.InjectedMethodInvocation: Creates a InjectedMethodInvocation object that is able to invoke the provided method.
forStatic(Method, Injector) - Static method in class de.skuzzle.inject.async.util.InjectedMethodInvocation: Creates an InjectedMethodInvocation object that is able to invoke the provided static method.
fromInvocation(MethodInvocation) - Static method in class de.skuzzle.inject.async.internal.runnables.InvocationCallable: Wraps the given AOP method invocation into a runnable for asynchronous execution.
Futures - Class in de.skuzzle.inject.async.util: Utility to create dummy Future objects to use in methods annotated with Async.

G

get() - Method in class de.skuzzle.inject.async.internal.runnables.InvocationCallable
getContext() - Static method in class de.skuzzle.inject.async.internal.context.ScheduledContextHolder: May be used to access the ScheduledContext which is currently active for the current thread.
getExecution() - Method in interface de.skuzzle.inject.async.ScheduledContext: Gets the current execution context.
getExecutionCount() - Method in interface de.skuzzle.inject.async.ScheduledContext: Gets the number of times that this method has been executed.
getExecutionNr() - Method in interface de.skuzzle.inject.async.ExecutionContext: Returns the execution number.
getMethod() - Method in interface de.skuzzle.inject.async.ExecutionContext: Gets the scheduled method to which this scope belongs.
getMethod() - Method in interface de.skuzzle.inject.async.ScheduledContext: Gets the scheduled method to which this scope belongs.
getProperties() - Method in interface de.skuzzle.inject.async.ExecutionContext: Gets the properties that are attached to this context.
getProperties() - Method in interface de.skuzzle.inject.async.ScheduledContext: Gets the properties that are attached to this context.
getStrategyFor(Annotation) - Method in interface de.skuzzle.inject.async.internal.TriggerStrategyRegistry: Gets the TriggerStrategy that is able to handle the provided trigger annotation.
getTriggerType() - Method in class de.skuzzle.inject.async.internal.trigger.CronTriggerStrategy
getTriggerType() - Method in class de.skuzzle.inject.async.internal.trigger.DelayedTriggerStrategy
getTriggerType() - Method in class de.skuzzle.inject.async.internal.trigger.SimpleTriggerStrategy
getTriggerType() - Method in interface de.skuzzle.inject.async.TriggerStrategy: Returns the annotation type that this strategy can handle.
getType() - Method in enum de.skuzzle.inject.async.annotation.CronType: Maps this cron type to the back end's type.
GuiceAsync - Class in de.skuzzle.inject.async: Entry point for enabling asynchronous method support within your guice application.
GuiceAsyncService - Interface in de.skuzzle.inject.async: Allows to control some aspects of how the async-extension works.

H

handleException(Runnable, ExceptionHandler) - Method in interface de.skuzzle.inject.async.internal.runnables.RunnableBuilder: Creates a Runnable that wraps around the given one and which delegates excptions thrown by the inner runnable to the given handler.

I

InjectedMethodInvocation - Class in de.skuzzle.inject.async.util: Allows to invoke any method without explicitly providing its arguments.
InvocationCallable<T> - Class in de.skuzzle.inject.async.internal.runnables: Wraps a MethodInvocation object in a Callable for asynchronous execution.
invoke(InjectedMethodInvocation) - Method in interface de.skuzzle.inject.async.internal.runnables.RunnableBuilder: Creates a Runnable which will execute the given invocation.
InvokeMethodRunnable - Class in de.skuzzle.inject.async.internal.runnables: Wraps a MethodInvocation in a Runnable to allow it to be scheduled with a ScheduledExecutorService.
isCancelled() - Method in interface de.skuzzle.inject.async.ScheduledContext: Returns true if cancel has been called on this context.
isContextActive() - Static method in class de.skuzzle.inject.async.internal.context.ScheduledContextHolder: Tests whether the current thread is currently executing a scheduled method.

L

LockableRunnable - Interface in de.skuzzle.inject.async.internal.runnables: A runnable which is locked until LockableRunnable.release() is called.

M

MapBasedScope - Class in de.skuzzle.inject.async.util: A map-supplier based scope implementation.
MethodVisitor - Class in de.skuzzle.inject.async.util: Allows to iterate the methods of a class and its whole type hierarchy.

O

of(InjectedMethodInvocation) - Static method in class de.skuzzle.inject.async.internal.runnables.InvokeMethodRunnable: Creates a Runnable which will proceed the given MethodInvocation when being executed.
OnError - Annotation Type in de.skuzzle.inject.async.annotation: Can be put on a method which is annotated with Scheduled to additionally specify an exception handler.
onException(Exception) - Method in interface de.skuzzle.inject.async.ExceptionHandler: Call back for handling exceptions that occur in scheduled methods.

P

pop() - Static method in class de.skuzzle.inject.async.internal.context.ScheduledContextHolder: Removes the context for the current thread.
proceed() - Method in class de.skuzzle.inject.async.util.InjectedMethodInvocation: Actually executes the method.
push(ScheduledContext) - Static method in class de.skuzzle.inject.async.internal.context.ScheduledContextHolder: Registers the given context to be active for the current thread.

R

release() - Method in interface de.skuzzle.inject.async.internal.runnables.LockableRunnable: Releases the lock which causes this runnable to block.
Reschedulable - Interface in de.skuzzle.inject.async.internal.runnables: Runnable extension that allows to reschedule itself.
reschedule(ScheduledContext, Runnable, ScheduledExecutorService, ExecutionTime) - Method in interface de.skuzzle.inject.async.internal.runnables.RunnableBuilder: Creates a runnable that reschedules itself with the provided scheduler before actually executing the given invocation.
run() - Method in class de.skuzzle.inject.async.internal.runnables.InvokeMethodRunnable
RunnableBuilder - Interface in de.skuzzle.inject.async.internal.runnables: May be used to construct different types of runnables.
RunnablesModule - Class in de.skuzzle.inject.async.internal.runnables: Purely used internal to install runnables related bindings into the main module.
RunnablesModule(GuiceAsync) - Constructor for class de.skuzzle.inject.async.internal.runnables.RunnablesModule

S

schedule(ScheduledExecutorService, Runnable, long, long, TimeUnit) - Method in enum de.skuzzle.inject.async.annotation.SimpleScheduleType: Schedules a Runnable according to this scheduling type.
schedule(Method, Object, ScheduledExecutorService, ExceptionHandler) - Method in class de.skuzzle.inject.async.internal.trigger.CronTriggerStrategy
schedule(Method, Object, ScheduledExecutorService, ExceptionHandler) - Method in class de.skuzzle.inject.async.internal.trigger.DelayedTriggerStrategy
schedule(Method, Object, ScheduledExecutorService, ExceptionHandler) - Method in class de.skuzzle.inject.async.internal.trigger.SimpleTriggerStrategy
schedule(Method, Object, ScheduledExecutorService, ExceptionHandler) - Method in interface de.skuzzle.inject.async.TriggerStrategy: Extracts scheduling information from the provided Method and then schedules invocations of that method according to the information.
Scheduled - Annotation Type in de.skuzzle.inject.async.annotation: Marks a method to be executed periodically.
ScheduledContext - Interface in de.skuzzle.inject.async: Holds contextual information about a scheduled method.
ScheduledContextHolder - Class in de.skuzzle.inject.async.internal.context: Provides thread-local access to currently active ScheduledContextImpl.
ScheduledScope - Annotation Type in de.skuzzle.inject.async.annotation: A guice scope that pertains for one method annotated with Scheduled.
scheduleMemberMethod(Method, Object) - Method in interface de.skuzzle.inject.async.SchedulingService: Schedules the given member method if it is annotated with Scheduled.
scheduleNextExecution() - Method in interface de.skuzzle.inject.async.internal.runnables.Reschedulable: Schedules the next execution of this runnable.
Scheduler - Annotation Type in de.skuzzle.inject.async.annotation: Allows to specify the class part of the Key that is used to look up a ScheduledExecutorService for a method annotated with Scheduled.
scheduleStaticMethod(Method) - Method in interface de.skuzzle.inject.async.SchedulingService: Schedules the given static method if it is annotated with Scheduled.
SchedulingService - Interface in de.skuzzle.inject.async: Allows to manually schedule methods in the way they would normally automatically be scheduled by the framework.
scope(Runnable, ScheduledContext) - Method in interface de.skuzzle.inject.async.internal.runnables.RunnableBuilder: Creates a runnable which wraps around another runnable and executes the wrapped instance in the scope of the given ExecutionContext.
scope(Key<T>, Provider<T>) - Method in class de.skuzzle.inject.async.util.MapBasedScope
setFuture(Future<?>) - Method in interface de.skuzzle.inject.async.ScheduledContext: Sets the Future object for controlling the scheduled task.
shutdown(long, TimeUnit) - Method in interface de.skuzzle.inject.async.GuiceAsyncService: Performs an orderly shutdown of the internally used thread pools, using a best effort approach for stopping all active tasks.
SimpleScheduleType - Enum in de.skuzzle.inject.async.annotation: Defines the way in which a method annotated with SimpleTrigger is scheduled with a ScheduledExecutorService.
SimpleTrigger - Annotation Type in de.skuzzle.inject.async.annotation: A trigger annotation that allows to define a simple periodicity for method execution.
SimpleTriggerStrategy - Class in de.skuzzle.inject.async.internal.trigger: TriggerStrategy that handles the SimpleTrigger annotation for defining simple periodic executions.
SimpleTriggerStrategy() - Constructor for class de.skuzzle.inject.async.internal.trigger.SimpleTriggerStrategy

T

Trigger - Annotation Type in de.skuzzle.inject.async.annotation: Marks another annotation type to be a trigger annotation.
TriggerStrategy - Interface in de.skuzzle.inject.async: Defines how a certain Trigger annotation is handled in order to extract scheduling meta information and to actually schedule method invocations.
TriggerStrategyRegistry - Interface in de.skuzzle.inject.async.internal: Holds registered TriggerStrategy implementations.

V

valueOf(String) - Static method in enum de.skuzzle.inject.async.annotation.CronType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum de.skuzzle.inject.async.annotation.SimpleScheduleType: Returns the enum constant of this type with the specified name.
values() - Static method in enum de.skuzzle.inject.async.annotation.CronType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum de.skuzzle.inject.async.annotation.SimpleScheduleType: Returns an array containing the constants of this enum type, in the order they are declared.

W

withMapSupplier(Provider<Map<String, Object>>) - Static method in class de.skuzzle.inject.async.util.MapBasedScope: Creates a new scope which stores all instances into the map provided by the passed provider.

A B C D E F G H I L M O P R S T V W