Class ToolProvider

java.lang.Object

javax.tools.ToolProvider

public class ToolProvider
extends Object

Provides methods for locating tool providers, for example, providers of compilers. This class complements the functionality of ServiceLoader.

Since:

1.6

Method Summary

Modifier and Type	Method	Description
static DocumentationTool	getSystemDocumentationTool()	Returns the Java programming language documentation tool provided with this platform.
static JavaCompiler	getSystemJavaCompiler()	Returns the Java programming language compiler provided with this platform.
static ClassLoader	getSystemToolClassLoader()	Deprecated. This method is subject to removal in a future version of Java SE.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Method Details

getSystemJavaCompiler

public static JavaCompiler getSystemJavaCompiler()

Returns the Java programming language compiler provided with this platform.

The file manager returned by calling getStandardFileManager on this compiler supports paths provided by any filesystem.

Implementation Note:

This implementation returns the compiler provided by the jdk.compiler module if that module is available, and null otherwise.

Returns:

the compiler provided with this platform or null if no compiler is provided

getSystemDocumentationTool

public static DocumentationTool getSystemDocumentationTool()

Returns the Java programming language documentation tool provided with this platform.

The file manager returned by calling getStandardFileManager on this tool supports paths provided by any filesystem.

Implementation Note:

This implementation returns the tool provided by the jdk.javadoc module if that module is available, and null otherwise.

Returns:

the documentation tool provided with this platform or null if no documentation tool is provided

getSystemToolClassLoader

@Deprecated(since="9")
public static ClassLoader getSystemToolClassLoader()

Deprecated.

This method is subject to removal in a future version of Java SE. Use the system tool provider or service loader mechanisms to locate system tools as well as user-installed tools.

Returns a class loader that may be used to load system tools, or null if no such special loader is provided.

Implementation Requirements:

This implementation always returns null.

Returns:

a class loader, or null