public abstract class DebugCommandHandler extends AbstractHandler
IDebugCommandHandler
handlers. The specific type of IDebugCommandHandler
is
determined by the abstract getCommandType()
method.
Note: This class is not an implementation of the IDebugCommandHandler
interface, which was somewhat unfortunately named. IDebugCommandHandler
is an interface that used only by the debugger plug-ins. This class implements
IHandler
interface and is to be used with the
platform commands framework.
Clients may subclass this class.
IDebugCommandHandler
,
IHandler
Constructor and Description |
---|
DebugCommandHandler()
The constructor adds the handler as the
|
Modifier and Type | Method and Description |
---|---|
void |
dispose()
Clean up when removing
|
Object |
execute(ExecutionEvent event)
Executes with the map of parameter values by name.
|
protected abstract Class<?> |
getCommandType()
Returns the
IDebugCommandHandler
command handler that type this action executes. |
protected boolean |
getInitialEnablement()
Returns whether this action should be enabled when initialized
and there is no active debug context.
|
boolean |
isEnabled()
Whether this handler is capable of executing at this time.
|
protected void |
postExecute(IRequest request,
Object[] targets)
This method is called after the completion of the execution of this
command.
|
void |
setEnabled(Object evaluationContext)
Called by the framework to allow the handler to update its enabled state
by extracting the same information available at execution time.
|
addHandlerListener, fireHandlerChanged, hasListeners, isHandled, removeHandlerListener, setBaseEnabled
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
public DebugCommandHandler()
public void setEnabled(Object evaluationContext)
AbstractHandler
setEnabled
in interface IHandler2
setEnabled
in class AbstractHandler
evaluationContext
- the application context. May be null
AbstractHandler.setBaseEnabled(boolean)
public boolean isEnabled()
AbstractHandler
AbstractHandler.setEnabled(Object)
so they can be notified
about framework execution contexts.isEnabled
in interface IHandler
isEnabled
in class AbstractHandler
true
AbstractHandler.setEnabled(Object)
,
AbstractHandler.setBaseEnabled(boolean)
public Object execute(ExecutionEvent event) throws ExecutionException
IHandler
event
- An event containing all the information about the current
state of the application; must not be null
.null
.ExecutionException
- if an exception occurred during execution.protected void postExecute(IRequest request, Object[] targets)
request
- The completed request object which was given the the
debug command handler.targets
- Objects which were the targets of this actionprotected abstract Class<?> getCommandType()
IDebugCommandHandler
command handler that type this action executes.IDebugCommandHandler
protected boolean getInitialEnablement()
public void dispose()
dispose
in interface IHandler
dispose
in class AbstractHandler
IHandler.dispose()
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.