Class ShellUtils.ShellCommandExecutor

Enclosing class:

public static class ShellUtils.ShellCommandExecutor extends ShellUtils
A simple shell command executor. ShellCommandExecutorshould be used in cases where the output of the command needs no explicit parsing and where the command, working directory and the environment remains unchanged. The output of the command is stored as-is and is expected to be small.
  • Constructor Details

    • ShellCommandExecutor

      public ShellCommandExecutor(String[] execString)
    • ShellCommandExecutor

      public ShellCommandExecutor(String[] execString, File dir)
    • ShellCommandExecutor

      public ShellCommandExecutor(String[] execString, File dir, Map<String,String> env)
    • ShellCommandExecutor

      public ShellCommandExecutor(String[] execString, File dir, Map<String,String> env, long timeout)
      Create a new instance of the ShellCommandExecutor to execute a command.
      execString - The command to execute with arguments
      dir - If not-null, specifies the directory which should be set as the current working directory for the command. If null, the current working directory is not modified.
      env - If not-null, environment of the command will include the key-value pairs specified in the map. If null, the current environment is not modified.
      timeout - Specifies the time in milliseconds, after which the command will be killed and the status marked as timedout. If 0, the command will not be timed out.
  • Method Details

    • execute

      public void execute() throws IOException
      Execute the shell command.
    • getExecString

      public String[] getExecString()
      Description copied from class: ShellUtils
      return an array containing the command name & its parameters.
      Specified by:
      getExecString in class ShellUtils
    • parseExecResult

      protected void parseExecResult(BufferedReader lines) throws IOException
      Description copied from class: ShellUtils
      Parse the execution result.
      Specified by:
      parseExecResult in class ShellUtils
    • getOutput

      public String getOutput()
      Get the output of the shell command.
    • toString

      public String toString()
      Returns the commands of this instance. Arguments with spaces in are presented with quotes round; other arguments are presented raw
      toString in class Object
      a string representation of the object.