Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/tools/Tool.java@f5e5ca7505e2 (annotated)
src/share/classes/javax/tools/Tool.java
Wed, 08 Oct 2014 14:16:40 -0700
- author
- asaha
- date
- Wed, 08 Oct 2014 14:16:40 -0700
- changeset 2586
- f5e5ca7505e2
- parent 554
- 9d9f26857129
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Merge
| duke@1 | 1 | /* |
| ohair@554 | 2 | * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package javax.tools; |
| duke@1 | 27 | |
| duke@1 | 28 | import java.util.Set; |
| duke@1 | 29 | import java.io.InputStream; |
| duke@1 | 30 | import java.io.OutputStream; |
| duke@1 | 31 | import javax.lang.model.SourceVersion; |
| duke@1 | 32 | |
| duke@1 | 33 | /** |
| duke@1 | 34 | * Common interface for tools that can be invoked from a program. |
| duke@1 | 35 | * A tool is traditionally a command line program such as a compiler. |
| duke@1 | 36 | * The set of tools available with a platform is defined by the |
| duke@1 | 37 | * vendor. |
| duke@1 | 38 | * |
| duke@1 | 39 | * <p>Tools can be located using {@link |
| duke@1 | 40 | * java.util.ServiceLoader#load(Class)}. |
| duke@1 | 41 | * |
| duke@1 | 42 | * @author Neal M Gafter |
| duke@1 | 43 | * @author Peter von der Ahé |
| duke@1 | 44 | * @author Jonathan Gibbons |
| duke@1 | 45 | * @since 1.6 |
| duke@1 | 46 | */ |
| duke@1 | 47 | public interface Tool { |
| duke@1 | 48 | |
| duke@1 | 49 | /** |
| duke@1 | 50 | * Run the tool with the given I/O channels and arguments. By |
| duke@1 | 51 | * convention a tool returns 0 for success and nonzero for errors. |
| duke@1 | 52 | * Any diagnostics generated will be written to either {@code out} |
| duke@1 | 53 | * or {@code err} in some unspecified format. |
| duke@1 | 54 | * |
| duke@1 | 55 | * @param in "standard" input; use System.in if null |
| duke@1 | 56 | * @param out "standard" output; use System.out if null |
| duke@1 | 57 | * @param err "standard" error; use System.err if null |
| duke@1 | 58 | * @param arguments arguments to pass to the tool |
| duke@1 | 59 | * @return 0 for success; nonzero otherwise |
| duke@1 | 60 | * @throws NullPointerException if the array of arguments contains |
| duke@1 | 61 | * any {@code null} elements. |
| duke@1 | 62 | */ |
| duke@1 | 63 | int run(InputStream in, OutputStream out, OutputStream err, String... arguments); |
| duke@1 | 64 | |
| duke@1 | 65 | /** |
| duke@1 | 66 | * Gets the source versions of the Java™ programming language |
| duke@1 | 67 | * supported by this tool. |
| duke@1 | 68 | * @return a set of supported source versions |
| duke@1 | 69 | */ |
| duke@1 | 70 | Set<SourceVersion> getSourceVersions(); |
| duke@1 | 71 | |
| duke@1 | 72 | } |
