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

All Superinterfaces:

InterruptibleJobCommand, JobCommand

All Known Subinterfaces:

NotifyingRepeatingJobCommand

All Known Implementing Classes:

NotifyingRepeatingJobCommand.Null, RepeatingJobCommand.Null

public interface RepeatingJobCommand
extends JobCommand

This job command will execute repeatedly the minimum number of times. The assumption is the job command's effects are cumulative(?); i.e. the cumulative result of multiple executions of the job command is no different than the result of a single execution of the job command. Once the job command is executing, any further requests to execute simply trigger a re-execution of the job command once it has finished its current execution.

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

RepeatingJobCommand.Null Singleton implementation of the repeating job command interface that will do nothing when executed.

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.utility.command.JobCommand

JobCommand.Disabled

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.utility.command.InterruptibleJobCommand

InterruptibleJobCommand.Interrupted

Method Summary

void	start() Start the job command, allowing it to begin executing with the next call to JobCommand.execute(IProgressMonitor).
void	stop() Stop the job command; ignore further calls to JobCommand.execute(IProgressMonitor).

Methods inherited from interface org.eclipse.jpt.common.core.utility.command.JobCommand

execute

Method Detail

start

void start()

Start the job command, allowing it to begin executing with the next call to JobCommand.execute(IProgressMonitor).

Throws:

IllegalStateException - when the command is not stopped

stop

void stop()
          throws InterruptedException

Stop the job command; ignore further calls to JobCommand.execute(IProgressMonitor).

Throws:

IllegalStateException - when the command executor is not started

InterruptedException