org.eclipse.jpt.common.utility.command
Interface RepeatingCommand

All Superinterfaces:

Command, InterruptibleCommand

All Known Subinterfaces:

NotifyingRepeatingCommand

All Known Implementing Classes:

NotifyingRepeatingCommand.Null, RepeatingCommand.Null

public interface RepeatingCommand
extends Command

This command will execute repeatedly the minimum number of times. The assumption is the command's effects are cumulative(?); i.e. the cumulative result of multiple executions of the command is no different than the result of a single execution of the command. Once the command is executing, any further requests to execute simply trigger a re-execution of the 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

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

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

Command.Disabled

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

InterruptibleCommand.Interrupted

Method Summary

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

Methods inherited from interface org.eclipse.jpt.common.utility.command.Command

execute

Method Detail

start

void start()

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

Throws:

IllegalStateException - when the command is not stopped

stop

void stop()
          throws InterruptedException

Stop the command; ignore further calls to Command.execute().

Throws:

IllegalStateException - when the command executor is not started

InterruptedException