Interface ShellWriteSequence

All Known Implementing Classes:
ShellWriteSequence.DefaultShellWriteSequence

public interface ShellWriteSequence
Interface sequencing various things into terminal aware text types.
  • Method Details

    • clearScreen

      ShellWriteSequence clearScreen()
      Sequence terminal clear screen.
      Returns:
      a sequence for chaining
    • carriageReturn

      ShellWriteSequence carriageReturn()
      Sequence terminal carriage return.
      Returns:
      a sequence for chaining
    • command

      ShellWriteSequence command(String command)
      Sequence from command with expected carriage return.
      Parameters:
      command - the command
      Returns:
      a sequence for chaining
    • cr

      Sequence terminal carriage return. Alias for carriageReturn()
      Returns:
      a sequence for chaining
      See Also:
    • text

      Sequence text.
      Parameters:
      text - the text
      Returns:
      a sequence for chaining
    • keyDown

      Sequence terminal key down.
      Returns:
      a sequence for chaining
    • keyLeft

      Sequence terminal key left.
      Returns:
      a sequence for chaining
    • keyRight

      ShellWriteSequence keyRight()
      Sequence terminal key right.
      Returns:
      a sequence for chaining
    • keyUp

      Sequence terminal key up.
      Returns:
      a sequence for chaining
    • space

      Sequence terminal space.
      Returns:
      a sequence for chaining
    • ctrl

      ShellWriteSequence ctrl(char c)
      Sequence terminal ctrl.
      Returns:
      a sequence for chaining
    • build

      String build()
      Build the result.
      Returns:
      the result
    • of

      static ShellWriteSequence of(org.jline.terminal.Terminal terminal)
      Get a new instance of a ShellWriteSequence.
      Parameters:
      terminal - the terminal
      Returns:
      instance of a write sequence