Dali Provisional API
Release 3.2

org.eclipse.jpt.common.core.utility.command
Class ExtendedJobCommandExecutor.Inactive

java.lang.Object
  extended by org.eclipse.jpt.common.core.utility.command.ExtendedJobCommandExecutor.Inactive
All Implemented Interfaces:
Serializable, ExtendedJobCommandExecutor, JobCommandExecutor
Enclosing interface:
ExtendedJobCommandExecutor

public static final class ExtendedJobCommandExecutor.Inactive
extends Object
implements ExtendedJobCommandExecutor, Serializable

Singleton implementation of the command executor interface that ignores any commands.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.utility.command.ExtendedJobCommandExecutor
ExtendedJobCommandExecutor.Default, ExtendedJobCommandExecutor.Inactive
 
Field Summary
static ExtendedJobCommandExecutor INSTANCE
           
 
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.
static ExtendedJobCommandExecutor instance()
           
 String toString()
           
 void waitToExecute(JobCommand command)
          Suspend the current thread until the specified command is executed.
 boolean waitToExecute(JobCommand command, long timeout)
          Suspend the current thread until the specified command is executed or the specified time-out occurs.
 void waitToExecute(JobCommand command, String jobName)
          Suspend the current thread until the specified command is executed.
 void waitToExecute(JobCommand command, String jobName, ISchedulingRule schedulingRule)
          Suspend the current thread until the specified command is executed.
 boolean waitToExecute(JobCommand command, String jobName, ISchedulingRule schedulingRule, long timeout)
          Suspend the current thread until the specified command is executed or the specified time-out occurs.
 boolean waitToExecute(JobCommand command, String jobName, long timeout)
          Suspend the current thread until the specified command is executed or the specified time-out occurs.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INSTANCE

public static final ExtendedJobCommandExecutor INSTANCE
Method Detail

instance

public static ExtendedJobCommandExecutor instance()

execute

public void execute(JobCommand command)
Description copied from interface: JobCommandExecutor
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.

Specified by:
execute in interface JobCommandExecutor

execute

public void execute(JobCommand command,
                    String jobName)
Description copied from interface: JobCommandExecutor
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.

Specified by:
execute in interface JobCommandExecutor

execute

public void execute(JobCommand command,
                    String jobName,
                    ISchedulingRule schedulingRule)
Description copied from interface: JobCommandExecutor
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.

Specified by:
execute in interface JobCommandExecutor

waitToExecute

public void waitToExecute(JobCommand command)
Description copied from interface: ExtendedJobCommandExecutor
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. The command may or may not be assigned to a Job for execution.

Specified by:
waitToExecute in interface ExtendedJobCommandExecutor
See Also:
JobCommandExecutor.execute(JobCommand)

waitToExecute

public boolean waitToExecute(JobCommand command,
                             long timeout)
                      throws InterruptedException
Description copied from interface: ExtendedJobCommandExecutor
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. The command may or may not be assigned to a Job for execution.

Specified by:
waitToExecute in interface ExtendedJobCommandExecutor
Throws:
InterruptedException
See Also:
JobCommandExecutor.execute(JobCommand)

waitToExecute

public void waitToExecute(JobCommand command,
                          String jobName)
Description copied from interface: ExtendedJobCommandExecutor
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. The command may or may not be assigned to a Job for execution.

Specified by:
waitToExecute in interface ExtendedJobCommandExecutor
See Also:
JobCommandExecutor.execute(JobCommand, String)

waitToExecute

public boolean waitToExecute(JobCommand command,
                             String jobName,
                             long timeout)
                      throws InterruptedException
Description copied from interface: ExtendedJobCommandExecutor
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. The command may or may not be assigned to a Job for execution.

Specified by:
waitToExecute in interface ExtendedJobCommandExecutor
Throws:
InterruptedException
See Also:
JobCommandExecutor.execute(JobCommand, String)

waitToExecute

public void waitToExecute(JobCommand command,
                          String jobName,
                          ISchedulingRule schedulingRule)
Description copied from interface: ExtendedJobCommandExecutor
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. The command may or may not be assigned to a Job for execution.

Specified by:
waitToExecute in interface ExtendedJobCommandExecutor
See Also:
JobCommandExecutor.execute(JobCommand, String, ISchedulingRule)

waitToExecute

public boolean waitToExecute(JobCommand command,
                             String jobName,
                             ISchedulingRule schedulingRule,
                             long timeout)
                      throws InterruptedException
Description copied from interface: ExtendedJobCommandExecutor
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. The command may or may not be assigned to a Job for execution.

Specified by:
waitToExecute in interface ExtendedJobCommandExecutor
Throws:
InterruptedException
See Also:
JobCommandExecutor.execute(JobCommand, String, ISchedulingRule)

toString

public String toString()
Overrides:
toString in class Object

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.