DMDirc-Client/src/uk/org/ownage/dmdirc/commandparser/Command.java

/*
 * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package uk.org.ownage.dmdirc.commandparser;

/**
 * Represents a generic command
 * @author chris
 */
public abstract class Command {
    
    /**
     * The name of this command (i.e., the string used by the user to execute it)
     */
    protected String name;
    /**
     * The arity of this command
     */
    protected int arity = 0;
    /**
     * Whether this command is polyadic or not
     */
    protected boolean polyadic;
    /**
     * Whether this command should be shown in help output
     */
    protected boolean show = true;
    /**
     * A textual description of this command's arguments
     */
    protected String arguments = "<unknown>";
    /**
     * A description of this command
     */
    protected String description = "unknown";
    
    /**
     * Creates a new instance of Command
     */
    public Command() {
    }
    
    /**
     * Returns the signature of this command. For polyadic commands, the signature
     * is simply the name. For other commands, the signature is a concatenation of
     * the name, a literal "/", and the arity.
     * @return The signature of this command
     */
    public String getSignature() {
        if (polyadic) {
            return name;
        } else {
            return name+"/"+arity;
        }
    }
    
    /**
     * Returns whether or not this command should be shown in help messages
     * @return True iff the command should be shown, false otherwise
     */
    public boolean showInHelp() {
        return show;
    }
    
    /**
     * Returns a string representing the help message for this command
     * @return the help message for this command
     */
    public String getHelp() {
        return name+" "+arguments+" - "+description;
    }
    
    /**
     * Implodes the given list of arguments
     * @param args The arguments to implode
     * @return A string containing each argument seperated by a space
     */
    protected String implodeArgs(String... args) {
        String res = "";
        for (int i = 0; i < args.length; i++) {
            if (res.equals("")) {
                res = args[i];
            } else {
                res = res.concat(" "+args[i]);
            }
        }
        return res;
    }
    
    /**
     * Returns this command's name
     * @return The name of this command
     */
    public String getName() {
        return name;
    }
    
}