Dali Provisional API
Release 3.2

org.eclipse.jpt.common.core.utility.command
Class NotifyingRepeatingJobCommand.Null

java.lang.Object
  extended by org.eclipse.jpt.common.core.utility.command.NotifyingRepeatingJobCommand.Null
All Implemented Interfaces:
Serializable, InterruptibleJobCommand, JobCommand, NotifyingRepeatingJobCommand, RepeatingJobCommand
Enclosing interface:
NotifyingRepeatingJobCommand

public static final class NotifyingRepeatingJobCommand.Null
extends Object
implements NotifyingRepeatingJobCommand, Serializable

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

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.utility.command.NotifyingRepeatingJobCommand
NotifyingRepeatingJobCommand.Listener, NotifyingRepeatingJobCommand.Null
 
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
 
Field Summary
static NotifyingRepeatingJobCommand INSTANCE
           
 
Method Summary
 void addListener(NotifyingRepeatingJobCommand.Listener listener)
          Add the specified listener.
 IStatus execute(IProgressMonitor monitor)
          Execute the command.
static NotifyingRepeatingJobCommand instance()
           
 void removeListener(NotifyingRepeatingJobCommand.Listener listener)
          Remove the specified listener.
 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).
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INSTANCE

public static final NotifyingRepeatingJobCommand INSTANCE
Method Detail

instance

public static NotifyingRepeatingJobCommand instance()

start

public void start()
Description copied from interface: RepeatingJobCommand
Start the job command, allowing it to begin executing with the next call to JobCommand.execute(IProgressMonitor).

Specified by:
start in interface RepeatingJobCommand

execute

public IStatus execute(IProgressMonitor monitor)
Description copied from interface: JobCommand
Execute the command. The semantics of the command is determined by the contract between the client and server. The command should check, as appropriate, whether the specified progress monitor is "canceled"; if it is, the command should return a result status of severity IStatus.CANCEL. The singleton cancel status Status.CANCEL_STATUS can be used for this purpose.

Nested methods can also check the progress monitor and, if it is "canceled", throw an OperationCanceledException.

Specified by:
execute in interface InterruptibleJobCommand
Specified by:
execute in interface JobCommand
See Also:
IProgressMonitor.isCanceled(), Job.run(IProgressMonitor monitor)

stop

public void stop()
Description copied from interface: RepeatingJobCommand
Stop the job command; ignore further calls to JobCommand.execute(IProgressMonitor).

Specified by:
stop in interface RepeatingJobCommand

addListener

public void addListener(NotifyingRepeatingJobCommand.Listener listener)
Description copied from interface: NotifyingRepeatingJobCommand
Add the specified listener.

Specified by:
addListener in interface NotifyingRepeatingJobCommand

removeListener

public void removeListener(NotifyingRepeatingJobCommand.Listener listener)
Description copied from interface: NotifyingRepeatingJobCommand
Remove the specified listener.

Specified by:
removeListener in interface NotifyingRepeatingJobCommand

toString

public String toString()
Overrides:
toString in class Object

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.