org.eclipse.jpt.common.core.utility.command
Interface JobCommandExecutor

All Known Subinterfaces:

CombinedCommandExecutor, CombinedExtendedCommandExecutor, ExtendedJobCommandExecutor

All Known Implementing Classes:

CombinedCommandExecutor.Default, CombinedCommandExecutor.Inactive, CombinedExtendedCommandExecutor.Default, CombinedExtendedCommandExecutor.Inactive, ExtendedJobCommandExecutor.Default, ExtendedJobCommandExecutor.Inactive, JobCommandExecutor.Default, JobCommandExecutor.Inactive

public interface JobCommandExecutor

This interface allows clients to control how a job command is executed. This is useful when the server provides the command but the client provides the context (e.g. the client would like to execute the command synchronously rather than dispatching it to a job queue).

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Nested Class Summary

static class	JobCommandExecutor.Default Singleton implementation of the command executor interface that simply executes the command without any sort of enhancement.
static class	JobCommandExecutor.Inactive Singleton implementation of the command executor interface that ignores any commands.

Method Summary

void	execute(JobCommand command) Execute the specified command, synchronously or asynchronously.
void	execute(JobCommand command, String jobName) Execute the specified command, synchronously or asynchronously.
void	execute(JobCommand command, String jobName, ISchedulingRule schedulingRule) Execute the specified command, synchronously or asynchronously.

Method Detail

execute

void execute(JobCommand command)

Execute the specified command, synchronously or asynchronously. Commands with the same scheduling rule must be executed in the order in which they are passed to the command executor. The command may or may not be assigned to a Job for execution.

execute

void execute(JobCommand command,
             String jobName)

Execute the specified command, synchronously or asynchronously. Commands with the same scheduling rule must be executed in the order in which they are passed to the command executor. The command may or may not be assigned to a Job for execution.

execute

void execute(JobCommand command,
             String jobName,
             ISchedulingRule schedulingRule)

Execute the specified command, synchronously or asynchronously. Commands with the same scheduling rule must be executed in the order in which they are passed to the command executor. The command may or may not be assigned to a Job for execution.