org.eclipse.tracecompass.tmf.remote.core/src/org/eclipse/tracecompass/tmf/remote/core/shell/ICommandShell.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2015 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Bernd Hufmann - Initial API and implementation
  11  *   Markus Schorn - Bug 448058: Use org.eclipse.remote in favor of RSE
  12  **********************************************************************/
  13 package org.eclipse.tracecompass.tmf.remote.core.shell;
  14
  15 import org.eclipse.core.commands.ExecutionException;
  16 import org.eclipse.core.runtime.IProgressMonitor;
  17 import org.eclipse.jdt.annotation.Nullable;
  18
  19 /**
  20  * Interface for a command shell implementation
  21  *
  22  * @author Bernd Hufmann
  23  */
  24 public interface ICommandShell {
  25
  26     /**
  27      * Method to disconnect the command shell.
  28      */
  29     void dispose();
  30
  31     /**
  32      * Method to execute a command on the command shell.
  33      *
  34      * @param command
  35      *            The command to executed
  36      * @param monitor
  37      *            A progress monitor
  38      * @return a {@link ICommandResult} instance
  39      * @throws ExecutionException
  40      *             If the command fails
  41      */
  42     ICommandResult executeCommand(ICommandInput command, @Nullable IProgressMonitor monitor) throws ExecutionException;
  43
  44     /**
  45      * Creates a command input instance
  46      *
  47      * @return {@link ICommandInput} instance
  48      *
  49      */
  50     ICommandInput createCommand();
  51 }