Class DebugCommandHandler

  • All Implemented Interfaces:
    IHandler, IHandler2

    public abstract class DebugCommandHandler
    extends AbstractHandler
    Abstract base class for re-targeting command framework handlers, which delegate execution to 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.

    See Also:
    IDebugCommandHandler, IHandler
    • Constructor Detail

      • DebugCommandHandler

        public DebugCommandHandler()
        The constructor adds the handler as the
    • Method Detail

      • setEnabled

        public void setEnabled​(Object evaluationContext)
        Description copied from class: AbstractHandler
        Called by the framework to allow the handler to update its enabled state by extracting the same information available at execution time. Clients may override if they need to extract information from the application context.
        Specified by:
        setEnabled in interface IHandler2
        setEnabled in class AbstractHandler
        evaluationContext - the application context. May be null
        See Also:
      • execute

        public Object execute​(ExecutionEvent event)
                       throws ExecutionException
        Description copied from interface: IHandler
        Executes with the map of parameter values by name.
        event - An event containing all the information about the current state of the application; must not be null.
        the result of the execution. Reserved for future use, must be null.
        ExecutionException - if an exception occurred during execution.
      • postExecute

        protected void postExecute​(IRequest request,
                                   Object[] targets)
        This method is called after the completion of the execution of this command. Extending classes may override this method to perform additional operation after command execution.
        request - The completed request object which was given the the debug command handler.
        targets - Objects which were the targets of this action
      • getInitialEnablement

        protected boolean getInitialEnablement()
        Returns whether this action should be enabled when initialized and there is no active debug context.
        false, by default