Interface CommandSession

All Superinterfaces:
AutoCloseable
All Known Implementing Classes:
CommandSessionImpl
public interface CommandSession extends AutoCloseable

  • Field Details

  • Method Details

    • currentDir

      Path currentDir()

    • currentDir

      void currentDir(Path path)

    • classLoader

      ClassLoader classLoader()

    • classLoader

      void classLoader(ClassLoader classLoader)

    • execute

      Object execute(CharSequence commandline) throws Exception
      Execute a program in this session.
      Parameters:
      commandline - the commandline
      Returns:
      the result of the execution
      Throws:
      Exception - on exception

    • close

      void close()
      Close this command session. After the session is closed, it will throw IllegalStateException when it is used.
      Specified by:
      close in interface AutoCloseable

    • getKeyboard

      InputStream getKeyboard()
      Return the input stream that is the first of the pipeline. This stream is sometimes necessary to communicate directly to the end user. For example, a "less" or "more" command needs direct input from the keyboard to control the paging.
      Returns:
      InpuStream used closest to the user or null if input is from a file.

    • getConsole

      PrintStream getConsole()
      Return the PrintStream for the console. This must always be the stream "closest" to the user. This stream can be used to post messages that bypass the piping. If the output is piped to a file, then the object returned must be null.
      Returns:
      PrintStream the console print stream

    • get

      Object get(String name)
      Get the value of a variable.
      Parameters:
      name - the name
      Returns:
      Object

    • put

      Object put(String name, Object value)
      Set the value of a variable.
      Parameters:
      name - Name of the variable.
      value - Value of the variable
      Returns:
      Object

    • format

      CharSequence format(Object target, int level)
      Convert an object to string form (CharSequence). The level is defined in the Converter interface, it can be one of INSPECT, LINE, PART. This function always returns a non null value. As a last resort, toString is called on the Object.
      Parameters:
      target - the target
      level - the level
      Returns:
      CharSequence

    • convert

      Object convert(Class<?> type, Object instance)
      Convert an object to another type.
      Parameters:
      type - the type
      instance - the instance
      Returns:
      Object

    • jobs

      List<Job> jobs()
      List jobs. Always return a non-null list.
      Returns:
      List<Job>

    • foregroundJob

      Job foregroundJob()
      Get the current foreground job or null.
      Returns:
      Job

    • setJobListener

      void setJobListener(JobListener listener)
      Set the job listener for this session.
      Parameters:
      listener - the listener