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

All Superinterfaces:

CommandExecutor

All Known Subinterfaces:

CombinedExtendedCommandExecutor, StatefulExtendedCommandExecutor

All Known Implementing Classes:

CombinedExtendedCommandExecutor.Default, CombinedExtendedCommandExecutor.Inactive, ExtendedCommandExecutor.Default, ExtendedCommandExecutor.Inactive

public interface ExtendedCommandExecutor
extends CommandExecutor

This interface extends the normal command executor; it allows the client to specify when a command must be executed synchronously.

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	ExtendedCommandExecutor.Default Singleton implementation of the command executor interface that simply executes the command without any sort of enhancement.
static class	ExtendedCommandExecutor.Inactive Singleton implementation of the command executor interface that ignores any commands.

Method Summary

void	waitToExecute(Command command) Suspend the current thread until the specified command is executed.
boolean	waitToExecute(Command command, long timeout) Suspend the current thread until the specified command is executed or the specified time-out occurs.

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

execute

Method Detail

waitToExecute

void waitToExecute(Command command)
                   throws InterruptedException

Suspend the current thread until the specified command is executed. The command itself must be executed after any other commands previously passed to the command executor (at least when passed from clients executing on the same thread).

Throws:

InterruptedException

See Also:

CommandExecutor.execute(Command)

waitToExecute

boolean waitToExecute(Command command,
                      long timeout)
                      throws InterruptedException

Suspend the current thread until the specified command is executed or the specified time-out occurs. The time-out is specified in milliseconds. Return true if the command was executed in the allotted time; return false if a time-out occurred and the command was not executed. If the time-out is zero, wait indefinitely.

The command itself must be executed after any other commands previously passed to the command executor (at least when passed from clients executing on the same thread).

Throws:

InterruptedException

See Also:

CommandExecutor.execute(Command)