org.qbicc.machine.tool.ToolInvoker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of qbicc-machine-tool-api Show documentation

The API for Qbicc machine tooling support

There is a newer version: 0.77.0

Show newest version

package org.qbicc.machine.tool;

import java.io.IOException;
import java.nio.file.Path;

/**
 * An invoker for an external program such as a compiler or linker.
 */
public interface ToolInvoker {
    /**
     * Get the tool corresponding to the invoker.
     *
     * @return the tool (not {@code null})
     */
    Tool getTool();

    /**
     * Get the path of the program that was run.
     *
     * @return the path (not {@code null})
     */
    Path getPath();

    /**
     * Get the program's working directory (null means use the same directory as the parent process)
     */
    Path getWorkingDirectory();

    /**
     * Set the program's working directory
     */
    void setWorkingDirectory(Path path);

    /**
     * Invoke the program.
     *
     * @throws IOException if program invocation failed for some reason
     */
    void invoke() throws IOException;
}