Module java.compiler
Package javax.tools

Interface DocumentationTool

  • All Superinterfaces:
    OptionChecker,Tool

    public interfaceDocumentationToolextendsTool,OptionChecker
    Interface to invoke Java™ programming language documentation tools from programs.
    Since:
    1.8
    • Method Detail

      • getStandardFileManager

        StandardJavaFileManager getStandardFileManager​(DiagnosticListener<? superJavaFileObject> diagnosticListener,Locale locale,Charset charset)
        Returns a new instance of the standard file manager implementation for this tool. The file manager will use the given diagnostic listener for producing any non-fatal diagnostics. Fatal errors will be signaled with the appropriate exceptions.

        The standard file manager will be automatically reopened if it is accessed after calls toflush orclose. The standard file manager must be usable with other tools.

        Parameters:
        diagnosticListener - a diagnostic listener for non-fatal diagnostics; ifnull use the compiler's default method for reporting diagnostics
        locale - the locale to apply when formatting diagnostics;null means thedefault locale.
        charset - the character set used for decoding bytes; ifnull use the platform default
        Returns:
        the standard file manager