APIdia Launch Partner
Top Description Constructors Methods
jdk.javadoc.internal.tool

public Class JavadocToolProvider

extends Object
implements ToolProvider
Class Inheritance
All Implemented Interfaces
java.util.spi.ToolProvider
Imports
com.sun.tools.javac.util.Context, .JavacMessages, java.io.PrintWriter, java.util.Optional, .ResourceBundle, java.util.spi.ToolProvider

An implementation of the ToolProvider SPI, providing access to JDK documentation tool, javadoc.
Since
9

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Optional<String>
description()

Overrides default java.util.spi.ToolProvider.description.

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

public String
name()

Implements java.util.spi.ToolProvider.name.

Returns the name of this tool provider.

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

Implements java.util.spi.ToolProvider.run.

Runs an instance of the tool, returning zero for a successful run.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

JavadocToolProviderback to summary
public JavadocToolProvider()

Method Detail

descriptionback to summary
public Optional<String> description()

Overrides default java.util.spi.ToolProvider.description.

Doc from java.util.spi.ToolProvider.description.

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

nameback to summary
public String name()

Implements java.util.spi.ToolProvider.name.

Doc from java.util.spi.ToolProvider.name.

Returns the name of this tool provider.

Annotations
@Override
runback to summary
public int run(PrintWriter out, PrintWriter err, String... args)

Implements java.util.spi.ToolProvider.run.

Doc from java.util.spi.ToolProvider.run.

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.

Annotations
@Override