javax.tools.Tool Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jx Show documentation
JavaX improved library - JDK-8
The newest version!
/*
 * Copyright (C) 2021 ZeoFlow SRL
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package javax.tools;

import javax.lang.model.SourceVersion;

import java.io.InputStream;
import java.io.OutputStream;
import java.util.Set;

/**
 * Common interface for tools that can be invoked from a program.
 * A tool is traditionally a command line program such as a compiler.
 * The set of tools available with a platform is defined by the
 * vendor.
 *
 * Tools can be located using {@link
 * java.util.ServiceLoader#load(Class)}.
 *
 * @author Neal M Gafter
 * @author Peter von der Ahé
 * @author Jonathan Gibbons
 * @since 1.6
 */
public interface Tool
{

    /**
     * Run the tool with the given I/O channels and arguments. By
     * convention a tool returns 0 for success and nonzero for errors.
     * Any diagnostics generated will be written to either {@code out}
     * or {@code err} in some unspecified format.
     *
     * @param in        "standard" input; use System.in if null
     * @param out       "standard" output; use System.out if null
     * @param err       "standard" error; use System.err if null
     * @param arguments arguments to pass to the tool
     *
     * @return 0 for success; nonzero otherwise
     *
     * @throws NullPointerException if the array of arguments contains
     *                              any {@code null} elements.
     */
    int run(InputStream in, OutputStream out, OutputStream err, String... arguments);

    /**
     * Gets the source versions of the Java™ programming language
     * supported by this tool.
     *
     * @return a set of supported source versions
     */
    Set getSourceVersions();

}