net.refractions.udig.project.command
Interface PostDeterminedEffectCommand

All Superinterfaces:
Command, MapCommand, UndoableCommand, UndoableMapCommand
All Known Implementing Classes:
UndoableComposite

public interface PostDeterminedEffectCommand
extends UndoableMapCommand

This is a special type of command that may or may not affect global state. Whether is does or not is not known until after the command has been ran. If the execute(IProgressMonitor) method returns true the command will be put on Undo stack otherwise it won't be because it does not need to be undone.

Since:
1.1.0
Author:
jones

Method Summary
 boolean execute(IProgressMonitor monitor)
          This method should return true if the method has changed state and will do something when undone.
 void run(IProgressMonitor monitor)
          This method will not be called it should throw a UnsupportedException exception.
 
Methods inherited from interface net.refractions.udig.project.command.MapCommand
getMap, setMap
 
Methods inherited from interface net.refractions.udig.project.command.Command
copy, getName
 
Methods inherited from interface net.refractions.udig.project.command.UndoableCommand
rollback
 
Methods inherited from interface net.refractions.udig.project.command.Command
copy, getName
 

Method Detail

run

void run(IProgressMonitor monitor)
         throws java.lang.Exception
This method will not be called it should throw a UnsupportedException exception.

Specified by:
run in interface Command
Parameters:
monitor - A progress monitor used by the command to report on its internal state. API how is this associated with a Thread? is it a Thread?
Throws:
java.lang.Exception

execute

boolean execute(IProgressMonitor monitor)
                throws java.lang.Exception
This method should return true if the method has changed state and will do something when undone.

Parameters:
monitor - used to indicate the progress of the monitor.
Returns:
true if the method has changed global state and command should be put on the undo stack.
Throws:
java.lang.Exception