OpenJDK 1.23 · java.util.spi.ToolProvider · APIdia, the JavaDoc alternative

Method Summary

Modifier and Type	Method and Description
public default Optional<String>	Returns: a short description of the tool, or an empty `Optional` if no description is available description() Returns a short description of the tool, or an empty `Optional` if no description is available.
public static Optional<ToolProvider>	Returns: an `Optional<ToolProvider>` of the first instance found findFirst(String the name of the desired tool provider name) Returns the first instance of a `ToolProvider` with the given name, as loaded by `ServiceLoader` using the system class loader.
public String	Returns: the name of this tool provider name() Returns the name of this tool provider.
public int	Returns: the result of executing the tool. A return value of 0 means the tool did not encounter any errors; any other value indicates that at least one error occurred during execution. run(PrintWriter a stream to which "expected" output should be written out, PrintWriter a stream to which any error messages should be written err, String... the command-line arguments for the tool args) Runs an instance of the tool, returning zero for a successful run.
public default int	Returns: the result of executing the tool. A return value of 0 means the tool did not encounter any errors; any other value indicates that at least one error occurred during execution. run(PrintStream a stream to which "expected" output should be written out, PrintStream a stream to which any error messages should be written err, String... the command-line arguments for the tool args) Runs an instance of the tool, returning zero for a successful run.

Method Detail

description back to summary

description	back to summary
public default Optional<String> description() Returns a short description of the tool, or an empty `Optional` if no description is available. API Note It is recommended that the description fits into a single line in order to allow creating concise overviews like the following: `jar Create, manipulate, and extract an archive of classes and resources. javac Read Java declarations and compile them into class files. jlink Assemble a set of modules (...) into a custom runtime image.` Implementation Specification This implementation returns an empty `Optional`. Returns:Optional<String> a short description of the tool, or an empty `Optional` if no description is available Since 19

public default Optional<String> description()

Returns a short description of the tool, or an empty Optional if no description is available.

API Note

It is recommended that the description fits into a single line in order to allow creating concise overviews like the following:

jar
  Create, manipulate, and extract an archive of classes and resources.
javac
  Read Java declarations and compile them into class files.
jlink
  Assemble a set of modules (...) into a custom runtime image.

Implementation Specification

This implementation returns an empty Optional.

Returns:Optional<String>: a short description of the tool, or an empty Optional if no description is available
Since: 19

findFirst back to summary

findFirst	back to summary
public static Optional<ToolProvider> findFirst(String name) Returns the first instance of a `ToolProvider` with the given name, as loaded by `ServiceLoader` using the system class loader. Parameters name:String the name of the desired tool provider Returns:Optional<ToolProvider> an `Optional<ToolProvider>` of the first instance found Annotations @SuppressWarnings:removal Exceptions NullPointerException: if `name` is `null`

public static Optional<ToolProvider> findFirst(String name)

Returns the first instance of a ToolProvider with the given name, as loaded by ServiceLoader using the system class loader.

Parameters

name:String: the name of the desired tool provider

Returns:Optional<ToolProvider>

an Optional<ToolProvider> of the first instance found

Annotations

@SuppressWarnings:removal

Exceptions

NullPointerException:: if name is null

name	back to summary
public String name() Returns the name of this tool provider. API Note It is recommended that the name be the same as would be used on the command line: for example, "javac", "jar", "jlink". Returns:String the name of this tool provider

name

back to summary

public String name()

Returns the name of this tool provider.

API Note

It is recommended that the name be the same as would be used on the command line: for example, "javac", "jar", "jlink".

Returns:String: the name of this tool provider

run back to summary

run	back to summary
public int run(PrintWriter out, PrintWriter err, String... args) Runs an instance of the tool, returning zero for a successful run. Any non-zero return value indicates a tool-specific error during the execution. Two streams should be provided, for "expected" output, and for any error messages. If it is not necessary to distinguish the output, the same stream may be used for both. API Note The interpretation of the arguments will be specific to each tool. Parameters out:PrintWriter a stream to which "expected" output should be written err:PrintWriter a stream to which any error messages should be written args:String[] the command-line arguments for the tool Returns:int the result of executing the tool. A return value of 0 means the tool did not encounter any errors; any other value indicates that at least one error occurred during execution. Exceptions NullPointerException: if any of the arguments are `null`, or if there are any `null` values in the `args` array

public int run(PrintWriter out, PrintWriter err, String... args)

Runs an instance of the tool, returning zero for a successful run. Any non-zero return value indicates a tool-specific error during the execution. Two streams should be provided, for "expected" output, and for any error messages. If it is not necessary to distinguish the output, the same stream may be used for both.

API Note

The interpretation of the arguments will be specific to each tool.

Parameters

out:PrintWriter: a stream to which "expected" output should be written
err:PrintWriter: a stream to which any error messages should be written
args:String[]: the command-line arguments for the tool

Returns:int

the result of executing the tool. A return value of 0 means the tool did not encounter any errors; any other value indicates that at least one error occurred during execution.

Exceptions

NullPointerException:: if any of the arguments are null, or if there are any null values in the args array

run back to summary

run	back to summary
public default int run(PrintStream out, PrintStream err, String... args) Runs an instance of the tool, returning zero for a successful run. Any non-zero return value indicates a tool-specific error during the execution. Two streams should be provided, for "expected" output, and for any error messages. If it is not necessary to distinguish the output, the same stream may be used for both. API Note The interpretation of the arguments will be specific to each tool. Implementation Note This implementation wraps the `out` and `err` streams within `PrintWriter`s, and then calls `run(PrintWriter, PrintWriter, String[])`. Parameters out:PrintStream a stream to which "expected" output should be written err:PrintStream a stream to which any error messages should be written args:String[] the command-line arguments for the tool Returns:int the result of executing the tool. A return value of 0 means the tool did not encounter any errors; any other value indicates that at least one error occurred during execution. Exceptions NullPointerException: if any of the arguments are `null`, or if there are any `null` values in the `args` array

public default int run(PrintStream out, PrintStream err, String... args)

API Note

The interpretation of the arguments will be specific to each tool.

Implementation Note

This implementation wraps the out and err streams within PrintWriters, and then calls run(PrintWriter, PrintWriter, String[]).

Parameters

out:PrintStream: a stream to which "expected" output should be written
err:PrintStream: a stream to which any error messages should be written
args:String[]: the command-line arguments for the tool

Returns:int

the result of executing the tool. A return value of 0 means the tool did not encounter any errors; any other value indicates that at least one error occurred during execution.

Exceptions

NullPointerException:: if any of the arguments are null, or if there are any null values in the args array

public Interface ToolProvider

Method Summary

Method Detail