001/*
002 * Copyright (c) 2016-2017 Daniel Ennis (Aikar) - MIT License
003 *
004 *  Permission is hereby granted, free of charge, to any person obtaining
005 *  a copy of this software and associated documentation files (the
006 *  "Software"), to deal in the Software without restriction, including
007 *  without limitation the rights to use, copy, modify, merge, publish,
008 *  distribute, sublicense, and/or sell copies of the Software, and to
009 *  permit persons to whom the Software is furnished to do so, subject to
010 *  the following conditions:
011 *
012 *  The above copyright notice and this permission notice shall be
013 *  included in all copies or substantial portions of the Software.
014 *
015 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
016 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
017 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
018 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
019 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
020 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
021 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
022 */
023
024package co.aikar.commands;
025
026import co.aikar.locales.MessageKey;
027import co.aikar.locales.MessageKeyProvider;
028
029public interface CommandIssuer {
030    /**
031     * Gets the issuer in the platforms native object
032     * @param <T>
033     * @return
034     */
035    <T> T getIssuer();
036
037    CommandManager getManager();
038
039    /**
040     * Is this issue a player, or server/console sender
041     * @return
042     */
043    boolean isPlayer();
044
045    /**
046     * Send the Command Issuer a message
047     * @param message
048     */
049    default void sendMessage(String message) {
050        getManager().sendMessage(this, MessageType.INFO, MessageKeys.INFO_MESSAGE, "{message}", message);
051    }
052
053    /**
054     * Has permission node
055     * @param permission
056     * @return
057     */
058    boolean hasPermission(String permission);
059
060    default void sendError(MessageKeyProvider key, String... replacements) {
061        sendMessage(MessageType.ERROR, key.getMessageKey(), replacements);
062    }
063    default void sendSyntax(MessageKeyProvider key, String... replacements) {
064        sendMessage(MessageType.SYNTAX, key.getMessageKey(), replacements);
065    }
066    default void sendInfo(MessageKeyProvider key, String... replacements) {
067        sendMessage(MessageType.INFO, key.getMessageKey(), replacements);
068    }
069    default void sendError(MessageKey key, String... replacements) {
070        sendMessage(MessageType.ERROR, key, replacements);
071    }
072    default void sendSyntax(MessageKey key, String... replacements) {
073        sendMessage(MessageType.SYNTAX, key, replacements);
074    }
075    default void sendInfo(MessageKey key, String... replacements) {
076        sendMessage(MessageType.INFO, key, replacements);
077    }
078    default void sendMessage(MessageType type, MessageKeyProvider key, String... replacements) {
079        sendMessage(type, key.getMessageKey(), replacements);
080    }
081    default void sendMessage(MessageType type, MessageKey key, String... replacements) {
082        getManager().sendMessage(this, type, key, replacements);
083    }
084
085    /**
086     * @deprecated Do not call this, for internal use. Not considered part of the API and may break.
087     * @param message
088     */
089    @Deprecated
090    void sendMessageInternal(String message);
091}