jdk8-mips64-public/langtools: src/share/classes/javax/tools/Tool.java@694ff82ca68e

7032975: API files in javax.annotation.processing need to be updated for references to JLS
7032972: API files in javax.tools need to updated for references to JVM Spec with editions/hyperlinks
7032978: API files in javax.tools need to be updated for references to JLS with editions/hyperlinks
Summary: Removed URLs and 'edition' references
Reviewed-by: jjg, darcy

     1 /*

     2  * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    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  */

    26 package javax.tools;

    28 import java.util.Set;

    29 import java.io.InputStream;

    30 import java.io.OutputStream;

    31 import javax.lang.model.SourceVersion;

    33 /**

    34  * Common interface for tools that can be invoked from a program.

    35  * A tool is traditionally a command line program such as a compiler.

    36  * The set of tools available with a platform is defined by the

    37  * vendor.

    38  *

    39  * <p>Tools can be located using {@link

    40  * java.util.ServiceLoader#load(Class)}.

    41  *

    42  * @author Neal M Gafter

    43  * @author Peter von der Ah&eacute;

    44  * @author Jonathan Gibbons

    45  * @since 1.6

    46  */

    47 public interface Tool {

    49     /**

    50      * Run the tool with the given I/O channels and arguments. By

    51      * convention a tool returns 0 for success and nonzero for errors.

    52      * Any diagnostics generated will be written to either {@code out}

    53      * or {@code err} in some unspecified format.

    54      *

    55      * @param in "standard" input; use System.in if null

    56      * @param out "standard" output; use System.out if null

    57      * @param err "standard" error; use System.err if null

    58      * @param arguments arguments to pass to the tool

    59      * @return 0 for success; nonzero otherwise

    60      * @throws NullPointerException if the array of arguments contains

    61      * any {@code null} elements.

    62      */

    63     int run(InputStream in, OutputStream out, OutputStream err, String... arguments);

    65     /**

    66      * Gets the source versions of the Java&trade; programming language

    67      * supported by this tool.

    68      * @return a set of supported source versions

    69      */

    70     Set<SourceVersion> getSourceVersions();

    72 }

Mercurial > jdk8-mips64-public > langtools / file revision

src/share/classes/javax/tools/Tool.java@694ff82ca68e

src/share/classes/javax/tools/Tool.java