/*
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.graalvm.component.installer;

import java.io.IOException;
import java.util.Map;

Interface for individual commands.
/**
 * Interface for individual commands.
 */
public interface InstallerCommand {
    
Provides supported options for the command. The installer will fail if other options are
specified on commandline than listed here. Place option specification into the Map under the
option name's key. Parametrized options are not supported at this moment. Use empty string
for parameter-less options.
Returns:
supported options/**
     * Provides supported options for the command. The installer will fail if other options are
     * specified on commandline than listed here. Place option specification into the Map under the
     * option name's key. Parametrized options are not supported at this moment. Use empty string
     * for parameter-less options.
     * 
     * @return supported options
     */
    Map<String, String> supportedOptions();

    
Executes a command.
Params:
commandInput – access to parameters, options
feedBack – output interface, use instead of Stderr, Stdout/**
     * Executes a command.
     * 
     * @param commandInput access to parameters, options
     * @param feedBack output interface, use instead of Stderr, Stdout
     */
    void init(CommandInput commandInput, Feedback feedBack);

    
Executes a command.
Throws:
IOException – if file-level operation fails./**
     * Executes a command.
     * 
     * @throws IOException if file-level operation fails.
     */
    int execute() throws IOException;
}