14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.tools;
27
28 import java.io.Writer;
29 import java.nio.charset.Charset;
30 import java.util.Locale;
31 import java.util.concurrent.Callable;
32
33 /**
34 * Interface to invoke Java™ programming language documentation tools from
35 * programs.
36 *
37 * @since 1.8
38 */
39 public interface DocumentationTool extends Tool, OptionChecker {
40 /**
41 * Creates a future for a documentation task with the given
42 * components and arguments. The task might not have
43 * completed as described in the DocumentationTask interface.
44 *
45 * <p>If a file manager is provided, it must be able to handle all
46 * locations defined in {@link DocumentationTool.Location},
47 * as well as
48 * {@link StandardLocation#SOURCE_PATH},
49 * {@link StandardLocation#CLASS_PATH}, and
50 * {@link StandardLocation#PLATFORM_CLASS_PATH}.
51 *
52 * @param out a Writer for additional output from the tool;
53 * use {@code System.err} if {@code null}
54 *
|
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.tools;
27
28 import java.io.Writer;
29 import java.nio.charset.Charset;
30 import java.util.Locale;
31 import java.util.concurrent.Callable;
32
33 /**
34 * Interface to invoke Java programming language documentation tools from
35 * programs.
36 *
37 * @since 1.8
38 */
39 public interface DocumentationTool extends Tool, OptionChecker {
40 /**
41 * Creates a future for a documentation task with the given
42 * components and arguments. The task might not have
43 * completed as described in the DocumentationTask interface.
44 *
45 * <p>If a file manager is provided, it must be able to handle all
46 * locations defined in {@link DocumentationTool.Location},
47 * as well as
48 * {@link StandardLocation#SOURCE_PATH},
49 * {@link StandardLocation#CLASS_PATH}, and
50 * {@link StandardLocation#PLATFORM_CLASS_PATH}.
51 *
52 * @param out a Writer for additional output from the tool;
53 * use {@code System.err} if {@code null}
54 *
|