Source Code Cross Referenced for Tool.java in  » 6.0-JDK-Modules-sun » javac-compiler » javax » tools » Java Source Code / Java DocumentationJava Source Code and Java Documentation

01:        /*
02:         * Copyright 2005-2006 Sun Microsystems, Inc.  All Rights Reserved.
03:         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04:         *
05:         * This code is free software; you can redistribute it and/or modify it
06:         * under the terms of the GNU General Public License version 2 only, as
07:         * published by the Free Software Foundation.  Sun designates this
08:         * particular file as subject to the "Classpath" exception as provided
09:         * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22:         * CA 95054 USA or visit www.sun.com if you need additional information or
23:         * have any questions.
24:         */
25:
26:        package javax.tools;
27:
28:        import java.util.Set;
29:        import java.io.InputStream;
30:        import java.io.OutputStream;
31:        import javax.lang.model.SourceVersion;
32:
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 {
48:
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,
64:                    String... arguments);
65:
66:            /**
67:             * Gets the source versions of the Java&trade; programming language
68:             * supported by this tool.
69:             * @return a set of supported source versions
70:             */
71:            Set<SourceVersion> getSourceVersions();
72:
73:        }