TF-PlotSquared/PlotSquared/src/main/java/com/intellectualcrafters/plot/commands/Command.java

////////////////////////////////////////////////////////////////////////////////////////////////////
// PlotSquared - A plot manager and world generator for the Bukkit API                             /
// Copyright (c) 2014 IntellectualSites/IntellectualCrafters                                       /
//                                                                                                 /
// This program is free software; you can redistribute it and/or modify                            /
// it under the terms of the GNU General Public License as published by                            /
// the Free Software Foundation; either version 3 of the License, or                               /
// (at your option) any later version.                                                             /
//                                                                                                 /
// This program 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 General Public License                               /
// along with this program; if not, write to the Free Software Foundation,                         /
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA                               /
//                                                                                                 /
// You can contact us via: support@intellectualsites.com                                           /
////////////////////////////////////////////////////////////////////////////////////////////////////
package com.intellectualcrafters.plot.commands;

/**
 * Created by Citymonstret on 2014-08-03.
 *
 * @author Citymonstret
 * @author Empire92
 */
public enum Command {
    // TODO new commands
    // (economy)
    // - /plot buy
    // - /plot sell <value>
    // (Rating system) (ratings can be stored as the average, and number of
    // ratings)
    // - /plot rate <number out of 10>
    FLAG("flag", "f"),
    TARGET("target"),
    CLUSTER("cluster", "clusters"),
    BUY("buy", "b"),
    CREATEROADSCHEMATIC("createroadschematic"),
    DEBUGROADREGEN("debugroadregen"),
    DEBUGFIXFLAGS("debugfixflags"),
    REGENALLROADS("regenallroads"),
    DEBUGLOADTEST("debugloadtest"),
    DEBUGSAVETEST("debugsavetest"),
    UNCLAIM("unclaim"),
    DEBUGCLEAR("debugclear"),
    SWAP("swap"),
    INBOX("inbox"),
    DEBUGCLAIMTEST("debugclaimtest"),
    COMMENT("comment", "msg"),
    TRUSTED("trusted", "trust"),
    PASTE("paste"),
    CLIPBOARD("clipboard", "cboard"),
    COPY("copy"),
    KICK("kick", "k"),
    HELPERS("helpers", "hp"),
    DENIED("denied", "dn"),
    CLAIM("claim", "c"),
    MERGE("merge", "m"),
    UNLINK("unlink", "u"),
    CLEAR("clear", "clear", new CommandPermission("plots.clear")),
    DELETE("delete", "d", new CommandPermission("plots.delete")),
    DEBUG("debug", "debug", new CommandPermission("plots.admin")),
    INTERFACE("interface", "int", new CommandPermission("plots.interface")),
    HOME("home", "h"),
    INFO("info", "i"),
    LIST("list", "l"),
    SET("set", "s"),
    PURGE("purge"),
    OP("op", "add"),
    DEOP("deop", "deadmin"),
    BAN("ban", "block"),
    UNBAN("unban", "unblock"),
    DATABASE("database", "convert"),
    TP("tp", "tp");
    /**
     * Command
     */
    private final String command;
    /**
     * Alias
     */
    private final String alias;
    /**
     * Permission Node
     */
    private final CommandPermission permission;

    /**
     * @param command Command "name" (/plot [cmd])
     */
    Command(final String command) {
        this.command = command;
        this.alias = command;
        this.permission = new CommandPermission("plots." + command);
    }

    /**
     * @param command    Command "name" (/plot [cmd])
     * @param permission Command Permission Node
     */
    Command(final String command, final CommandPermission permission) {
        this.command = command;
        this.permission = permission;
        this.alias = command;
    }

    /**
     * @param command Command "name" (/plot [cmd])
     * @param alias   Command Alias
     */
    Command(final String command, final String alias) {
        this.command = command;
        this.alias = alias;
        this.permission = new CommandPermission("plots." + command);
    }

    /**
     * @param command    Command "name" (/plot [cmd])
     * @param alias      Command Alias
     * @param permission Required Permission Node
     */
    Command(final String command, final String alias, final CommandPermission permission) {
        this.command = command;
        this.alias = alias;
        this.permission = permission;
    }

    /**
     * @return command
     */
    public String getCommand() {
        return this.command;
    }

    /**
     * @return alias
     */
    public String getAlias() {
        return this.alias;
    }

    /**
     * @return permission object
     *
     * @see com.intellectualcrafters.plot.commands.CommandPermission
     */
    public CommandPermission getPermission() {
        return this.permission;
    }
}