Package cloud.commandframework.bukkit

Class BukkitCommandSender

  • public abstract class BukkitCommandSender
extends java.lang.Object
    Command sender that proxies CommandSender

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected BukkitCommandSender​(@NonNull org.bukkit.command.CommandSender internalSender)
      Create a new command sender from a Bukkit CommandSender

    • Method Summary

      Modifier and Type Method Description
      abstract @NonNull org.bukkit.entity.Player asPlayer()
      Get this sender as a player.
      static @NonNull BukkitCommandSender console()
      Construct a new BukkitCommandSender for the Bukkit console
      boolean equals​(java.lang.Object o)  
      @NonNull org.bukkit.command.CommandSender getInternalSender()
      Get the proxied CommandSender
      int hashCode()  
      abstract boolean isPlayer()
      Check if this sender represents a player
      static @NonNull BukkitCommandSender of​(@NonNull org.bukkit.command.CommandSender sender)
      Construct a new BukkitCommandSender from a Bukkit CommandSender
      static @NonNull BukkitCommandSender player​(@NonNull org.bukkit.entity.Player player)
      Construct a new BukkitCommandSender for a Player
      void sendMessage​(@NonNull java.lang.String message)
      Send a message to the command sender

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BukkitCommandSender

        protected BukkitCommandSender​(@NonNull org.bukkit.command.CommandSender internalSender)
        Create a new command sender from a Bukkit CommandSender
        Parameters:
        internalSender - Bukkit command sender

    • Method Detail

      • player

        public static @NonNull BukkitCommandSender player​(@NonNull org.bukkit.entity.Player player)
        Construct a new BukkitCommandSender for a Player
        Parameters:
        player - Player instance
        Returns:
        Constructed command sender

      • of

        public static @NonNull BukkitCommandSender of​(@NonNull org.bukkit.command.CommandSender sender)
        Construct a new BukkitCommandSender from a Bukkit CommandSender
        Parameters:
        sender - Bukkit command sender
        Returns:
        Constructed command sender

      • equals

        public final boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getInternalSender

        public @NonNull org.bukkit.command.CommandSender getInternalSender()
        Get the proxied CommandSender
        Returns:
        Proxied command sneder

      • isPlayer

        public abstract boolean isPlayer()
        Check if this sender represents a player
        Returns:
        true if this sender represents a player, false if not

      • asPlayer

        public abstract @NonNull org.bukkit.entity.Player asPlayer()
        Get this sender as a player. This can only safely be done if isPlayer()} returns true
        Returns:
        Player object

      • sendMessage

        public void sendMessage​(@NonNull java.lang.String message)
        Send a message to the command sender
        Parameters:
        message - Message to send