com.anrisoftware.globalpom.exec.api.CommandLine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalpomutils-exec Show documentation
Command execution helper.
There is a newer version: 4.7.0
/*
 * Copyright 2014-2015 Erwin Müller 
 *
 * This file is part of globalpomutils-exec.
 *
 * globalpomutils-exec is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * globalpomutils-exec 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 for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with globalpomutils-exec. If not, see .
 */
package com.anrisoftware.globalpom.exec.api;

import java.io.File;
import java.util.List;

import com.anrisoftware.globalpom.exec.command.DefaultCommandLine;

/**
 * Quotes command line arguments.
 * 
 * @author Erwin Mueller, [email protected]
 * @since 2.0
 */
public interface CommandLine {

    /**
     * Returns the of the command list.
     * 
     * @return the unmodifiable {@link List} of {@link String} that contains the
     *         executable as the first item and the command arguments as the
     *         rest.
     * 
     * @throws CommandExecException
     *             if there was an error create the command.
     */
    List getCommand() throws CommandExecException;

    /**
     * Returns the executable.
     * 
     * @return the {@link Object} executable to run, can be the name of the
     *         executable or the path or any other abstract object.
     */
    Object getExecutable();

    /**
     * Returns the arguments.
     * 
     * @return the unmodifiable {@link List} of arguments.
     */
    List getArguments();

    /**
     * Adds the specified command line arguments.
     * 
     * @param arguments
     *            the {@link Object} array arguments.
     * 
     * @return this {@link DefaultCommandLine}.
     */
    CommandLine add(Object... arguments);

    /**
     * Adds the specified command line arguments.
     * 
     * @param quote
     *            set to {@code true} to quote the argument.
     * 
     * @param arguments
     *            the {@link Object} array arguments.
     * 
     * @return this {@link DefaultCommandLine}.
     */
    CommandLine add(boolean quote, Object... arguments);

    /**
     * Adds the specified command line argument.
     * 
     * @param arguments
     *            the {@link Object} argument.
     * 
     * @return this {@link DefaultCommandLine}.
     */
    CommandLine add(Object argument);

    /**
     * Adds the specified command line argument.
     * 
     * If the quote arguments is set then the arguments is quoted in
     * double/single quotes.
     * 

     * {@code aaa} -> {@code aaa}
     * {@code aaa bbb} -> {@code "aaa bbb"}
     * {@code "aaa" bbb} -> {@code '"aaa" bbb'}
     * {@code "aaa ccc" bbb} -> {@code '"aaa ccc" bbb'}
     * {@code "aaa"bbb} -> {@code '"aaa"bbb'}
     * 
     * 
     * 
     * @param argument
     *            the {@link Object} argument.
     * 
     * @param quote
     *            set to {@code true} to quote the argument.
     * 
     * @return this {@link DefaultCommandLine}.
     */
    CommandLine add(boolean quote, Object argument);

    /**
     * Adds a variable substitution for the arguments. The variables are only
     * substituted when the arguments are returned. The variables must be
     * enclosed in the enclose {@code "<", ">"}, for example:
     * {@code "foo=".}
     * 
     * @param name
     *            the {@link String} name of the variable.
     * 
     * @param value
     *            the {@link Object} value of the variable.
     * 
     * @return this {@link DefaultCommandLine}.
     */
    CommandLine addSub(String name, Object value);

    /**
     * Sets the working directory.
     * 
     * @param dir
     *            the {@link File} directory or {@code null} to use the working
     *            directory of the current Java process.
     */
    void setWorkingDir(File dir);

    /**
     * Returns the working directory.
     * 
     * @return the {@link File} directory or {@code null} to use the working
     *         directory of the current Java process.
     */
    File getWorkingDir();

    /**
     * Sets the variable substitution start character. The start character
     * defaults to "<".
     * 
     * @param character
     *            the character.
     */
    void setVariableStartChar(char character);

    /**
     * Sets the variable substitution stop character. The stop character
     * defaults to ">".
     * 
     * @param character
     *            the character.
     */
    void setVariableStopChar(char character);

    @Override
    String toString();

}