co.aikar.commands.CommandIssuer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of acf-core Show documentation
The newest version!
/*
 * Copyright (c) 2016-2017 Daniel Ennis (Aikar) - MIT License
 *
 *  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 co.aikar.commands;

import co.aikar.locales.MessageKey;
import co.aikar.locales.MessageKeyProvider;
import org.jetbrains.annotations.NotNull;

import java.util.UUID;

public interface CommandIssuer {
    /**
     * Gets the issuer in the platforms native object
     * @param 
     * @return
     */
     T getIssuer();

    CommandManager getManager();

    /**
     * Is this issue a player, or server/console sender
     * @return
     */
    boolean isPlayer();

    /**
     * Send the Command Issuer a message
     * @param message
     */
    default void sendMessage(String message) {
        getManager().sendMessage(this, MessageType.INFO, MessageKeys.INFO_MESSAGE, "{message}", message);
    }

    /**
     * @return the unique id of that issuer
     */
    @NotNull UUID getUniqueId();

    /**
     * Has permission node
     * @param permission
     * @return
     */
    boolean hasPermission(String permission);

    default void sendError(MessageKeyProvider key, String... replacements) {
        sendMessage(MessageType.ERROR, key.getMessageKey(), replacements);
    }
    default void sendSyntax(MessageKeyProvider key, String... replacements) {
        sendMessage(MessageType.SYNTAX, key.getMessageKey(), replacements);
    }
    default void sendInfo(MessageKeyProvider key, String... replacements) {
        sendMessage(MessageType.INFO, key.getMessageKey(), replacements);
    }
    default void sendError(MessageKey key, String... replacements) {
        sendMessage(MessageType.ERROR, key, replacements);
    }
    default void sendSyntax(MessageKey key, String... replacements) {
        sendMessage(MessageType.SYNTAX, key, replacements);
    }
    default void sendInfo(MessageKey key, String... replacements) {
        sendMessage(MessageType.INFO, key, replacements);
    }
    default void sendMessage(MessageType type, MessageKeyProvider key, String... replacements) {
        sendMessage(type, key.getMessageKey(), replacements);
    }
    default void sendMessage(MessageType type, MessageKey key, String... replacements) {
        getManager().sendMessage(this, type, key, replacements);
    }

    /**
     * @deprecated Do not call this, for internal use. Not considered part of the API and may break.
     * @param message
     */
    @Deprecated
    void sendMessageInternal(String message);
}