模块  jdk.jshell
软件包  jdk.jshell.tool

Interface JavaShellToolBuilder

  • public interface JavaShellToolBuilder
    用于配置和运行Java shell工具实例的接口。 使用静态builder()方法创建构建器的实例。 可以选择使用配置方法配置此构建器。 所有配置方法都返回构建器实例以在链式初始化中使用。 所有配置方法都有合理的默认值，如果没有调用它们将被使用。在对配置方法进行零次或多次调用之后，通过调用run(java.lang.String...)启动该工具。
    从以下版本开始：
    9

    • 方法详细信息

      • builder

        static JavaShellToolBuilder builder()
        创建用于启动JDK jshell工具的构建器。
        结果
        可用于配置和启动jshell工具的构建器

      • in

        JavaShellToolBuilder in​(InputStream cmdIn,                        InputStream userIn)
        设置输入通道。
        实现要求：
        如果未调用此方法，则行为应等同于调用 in(System.in, null) 。
        参数
        cmdIn - 命令输入源
        userIn - 用于运行用户代码的输入源，或 null用于从cmdIn中提取用户输入
        结果
        JavaShellToolBuilder实例

      • out

        JavaShellToolBuilder out​(PrintStream output)
        设置输出通道。 与out(output, output, output)相同。
        实现要求：
        如果既没有 out方法，则行为应该等同于调用 out(System.out) 。
        参数
        output - 命令反馈，控制台交互和用户代码输出的目标
        结果
        JavaShellToolBuilder实例

      • out

        JavaShellToolBuilder out​(PrintStream cmdOut,                         PrintStream console,                         PrintStream userOut)
        设置输出通道。
        实现要求：
        如果既没有 out方法，则该行为应该等同于调用 out(System.out, System.out, System.out) 。
        参数
        cmdOut - 命令反馈的目的地，包括用户的错误消息
        console - 控制台交互的目的地
        userOut - 用户代码输出的目标。 例如，用户代码段System.out.println("Hello")在执行时Hello转到userOut。
        结果
        JavaShellToolBuilder实例

      • err

        JavaShellToolBuilder err​(PrintStream error)
        设置错误通道。 与err(error, error)相同。
        实现要求：
        如果既没有 err方法，则行为应该等同于调用 err(System.err) 。
        参数
        error - 工具错误的目标和用户代码错误
        结果
        JavaShellToolBuilder实例

      • err

        JavaShellToolBuilder err​(PrintStream cmdErr,                         PrintStream userErr)
        设置错误通道。
        实现要求：
        如果既未 err方法，则行为应等效于调用 err(System.err, System.err, System.err) 。
        参数
        cmdErr - 工具启动和致命错误的目的地
        userErr - 用户代码错误输出的目标。 例如，用户代码段System.err.println("Oops")在执行时Oops转到userErr。
        结果
        JavaShellToolBuilder实例

      • persistence

        JavaShellToolBuilder persistence​(Preferences prefs)
        设置持久性信息的存储机制，包括输入历史记录和保留的设置。
        实现要求：
        如果没有 persistence方法，则行为应该是使用工具的标准持久性机制。
        参数
        prefs - 用于检索和存储持久性信息的Preferences的实例
        结果
        JavaShellToolBuilder实例

      • persistence

        JavaShellToolBuilder persistence​(Map<String,​String> prefsMap)
        设置持久性信息的存储机制，包括输入历史记录和保留的设置。
        实现要求：
        如果没有 persistence方法，则行为应该是使用工具的标准持久性机制。
        参数
        prefsMap - 用于检索和存储持久性信息的Map的实例
        结果
        JavaShellToolBuilder实例

      • env

        JavaShellToolBuilder env​(Map<String,​String> vars)
        设置环境变量的源。
        实现要求：
        如果未调用此方法，则行为应等效于调用 env(System.getenv()) 。
        参数
        vars - 环境变量名称到值的映射
        结果
        JavaShellToolBuilder实例

      • locale

        JavaShellToolBuilder locale​(Locale locale)
        设置区域设置。
        实现要求：
        如果未调用此方法，则行为应等同于调用 locale(Locale.getDefault()) 。
        参数
        locale - 区域设置
        结果
        JavaShellToolBuilder实例

      • promptCapture

        JavaShellToolBuilder promptCapture​(boolean capture)
        设置为启用命令捕获提示覆盖。
        实现要求：
        如果未调用此方法，则行为应等效于调用 promptCapture(false) 。
        参数
        capture - 如果是true ，则基本提示符为ENQ字符，继续提示符为ACK字符。 如果为false，则提示与设置或用户/set命令一样。
        结果
        JavaShellToolBuilder实例

      • run

        void run​(String... arguments)  throws 异常
        运行此shell界面中其他方法配置的Java shell工具实例。 此调用不具有破坏性，可以从已配置的构建器调用此方法。 Java shell工具的退出代码将被忽略。
        参数
        arguments - 命令行参数（包括选项），如果有的话
        异常
        异常 - 意外的致命异常

      • start

        default int start​(String... arguments)           throws 异常
        运行此shell界面中其他方法配置的Java shell工具实例。 此调用不具有破坏性，可以从已配置的构建器调用此方法。
        实现要求：
        默认实现始终返回零。 此接口的实现应覆盖此方法，返回退出状态。
        参数
        arguments - 命令行参数（包括选项），如果有的话
        结果
        工具明确退出的退出状态（如果有），否则为0表示成功，1表示失败
        异常
        异常 - 意外的致命异常