io.github.portlek.input.ChatSender Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of input-common Show documentation

The newest version!

/*
 * MIT License
 *
 * Copyright (c) 2021 Hasan Demirtaş
 *
 * 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 io.github.portlek.input;

import java.util.UUID;
import org.jetbrains.annotations.NotNull;

/**
 * an interface to determine the input's sender.
 *
 * @param  the abstract type of the sender.
 */
public interface ChatSender extends ChatWrap {

  /**
   * obtains sender's unique id.
   *
   * @return the unique id of the sender.
   */
  @NotNull
  UUID getUniqueId();

  /**
   * sends the given message to the input's sender.
   *
   * @param message the message to send.
   */
  void sendMessage(@NotNull String message);
}