org.eclipse.amp.escape.command
Class ResourceHandler

java.lang.Object
  extended by org.eclipse.core.commands.common.EventManager
      extended by org.eclipse.core.commands.AbstractHandler
          extended by org.eclipse.amp.escape.command.ResourceHandler
All Implemented Interfaces:
org.eclipse.core.commands.IHandler, org.eclipse.core.commands.IHandler2
Direct Known Subclasses:
ExecuteHandler

public abstract class ResourceHandler
extends org.eclipse.core.commands.AbstractHandler

Executes an arbitrary task upon a resource. Clients should override #execute(IResource).

Author:
milesparker

Constructor Summary
ResourceHandler()
           
 
Method Summary
 java.lang.Object execute(org.eclipse.core.commands.ExecutionEvent event)
           
 void execute(org.eclipse.core.resources.IResource resource)
          Override with desired execution behavior.
 void execute(java.lang.Object resource, java.lang.String name)
          Execute.
 void executeHandler(org.eclipse.core.commands.ExecutionEvent event, java.lang.Object resource, java.lang.String name)
          Execute handler.
 org.eclipse.core.runtime.IProgressMonitor getMonitor()
          Gets the monitor.
 void setMonitor(org.eclipse.core.runtime.IProgressMonitor monitor)
          Sets the monitor.
 
Methods inherited from class org.eclipse.core.commands.AbstractHandler
addHandlerListener, dispose, fireHandlerChanged, hasListeners, isEnabled, isHandled, removeHandlerListener, setBaseEnabled, setEnabled
 
Methods inherited from class org.eclipse.core.commands.common.EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceHandler

public ResourceHandler()
Method Detail

execute

public java.lang.Object execute(org.eclipse.core.commands.ExecutionEvent event)
                         throws org.eclipse.core.commands.ExecutionException
Throws:
org.eclipse.core.commands.ExecutionException

execute

public void execute(org.eclipse.core.resources.IResource resource)
             throws org.eclipse.core.commands.ExecutionException
Override with desired execution behavior.

Parameters:
resource - the resource
Throws:
org.eclipse.core.commands.ExecutionException - the execution exception

execute

public void execute(java.lang.Object resource,
                    java.lang.String name)
             throws org.eclipse.core.commands.ExecutionException
Execute.

Parameters:
resource - the resource
name - the name
Throws:
org.eclipse.core.commands.ExecutionException - the execution exception

executeHandler

public void executeHandler(org.eclipse.core.commands.ExecutionEvent event,
                           java.lang.Object resource,
                           java.lang.String name)
                    throws org.eclipse.core.commands.ExecutionException
Execute handler.

Parameters:
event - the event
resource - the resource
name - the name
Throws:
org.eclipse.core.commands.ExecutionException - the execution exception

getMonitor

public org.eclipse.core.runtime.IProgressMonitor getMonitor()
Gets the monitor.

Returns:
the monitor

setMonitor

public void setMonitor(org.eclipse.core.runtime.IProgressMonitor monitor)
Sets the monitor.

Parameters:
monitor - the new monitor