io.vertx.ext.shell

## Interface Shell

-     public interface Shell

  An interactive session between a consumer and a shell.
  Author:
    Julien Viet

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Close the shell.
    `Job` | `createJob(List<CliToken> line)` Create a job, the created job should then be executed with the `Job.run()` method.
    `Job` | `createJob(String line)` See `createJob(List)`
    `JobController` | `jobController()`
    `Session` | `session()`
    `void` | `setPrompt(java.util.function.Function<Session,String> prompt)` Set a new prompt in this session.

- - ### Method Detail

    - #### createJob

          Job createJob(List<CliToken> line)

      Create a job, the created job should then be executed with the `Job.run()` method.
      Parameters:
        `line` - the command line creating this job
      Returns:
        the created job

    - #### createJob

          Job createJob(String line)

      See `createJob(List)`

    - #### jobController

          JobController jobController()

      Returns:
        the shell's job controller

    - #### session

          Session session()

      Returns:
        the current shell session

    - #### setPrompt

          void setPrompt(java.util.function.Function<Session,String> prompt)

      Set a new prompt in this session.
      Parameters:
        `prompt` - the new prompt will be calculated when it's needed.

    - #### close

          void close()

      Close the shell.

Copyright © 2024 Eclipse. All rights reserved.