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

   1 /**********************************************************************
   2  * Copyright (c) 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 java.util.List;
  16
  17 import org.eclipse.jdt.annotation.Nullable;
  18
  19 /**
  20  * Interface for creating a command input to executued in a
  21  * {@link ICommandShell} implementation.
  22  *
  23  * @author Bernd Hufmann
  24  */
  25 public interface ICommandInput {
  26
  27     /**
  28      * Return the command output.
  29      *
  30      * It should not be null, but could be empty.
  31      * It should return an immutable list.
  32      *
  33      * @return the command output.
  34      */
  35     List<String> getInput();
  36
  37     /**
  38      * Adds a command segment to the command
  39      *
  40      * @param segment
  41      *            the command segment to add. Ignored if null.
  42      */
  43     void add(@Nullable String segment);
  44
  45     /**
  46      * Adds a command segments to the command
  47      *
  48      * @param segments
  49      *            the command segments to add. Ignored if null.
  50      *            Any null segment in list will be ignored too.
  51      */
  52     void addAll(List<String> segments);
  53 }