Class InputUtil.PlayerParser

java.lang.Object
com.sk89q.commandbook.util.InputUtil.PlayerParser
Enclosing class:
InputUtil

public static class InputUtil.PlayerParser
extends java.lang.Object
  • Constructor Summary

    Constructors 
    Constructor Description
    PlayerParser()  
  • Method Summary

    Modifier and Type Method Description
    static java.util.List<org.bukkit.entity.Player> checkPlayerMatch​(java.util.List<org.bukkit.entity.Player> players)
    Deprecated.
    static <T extends java.util.Collection<? extends org.bukkit.entity.Player>>
    T
    checkPlayerMatch​(T players)
    Checks if the given list of players is greater than size 0, otherwise throw an exception.
    static org.bukkit.entity.Player checkSinglePlayerMatch​(java.util.List<org.bukkit.entity.Player> players)
    Checks if the given list of players contains only one player, otherwise throw an exception.
    static java.lang.Iterable<org.bukkit.entity.Player> detectTargets​(org.bukkit.command.CommandSender sender, com.sk89q.minecraft.util.commands.CommandContext args, java.lang.String perm)  
    static org.bukkit.entity.Player matchPlayerExactly​(org.bukkit.command.CommandSender sender, java.lang.String filter)
    Match a single player exactly.
    static java.util.List<org.bukkit.entity.Player> matchPlayerNames​(org.bukkit.command.CommandSender source, java.lang.String filter)
    Match player names.
    static org.bukkit.command.CommandSender matchPlayerOrConsole​(org.bukkit.command.CommandSender sender, java.lang.String filter)
    Match only a single player or console.
    static java.util.List<org.bukkit.entity.Player> matchPlayers​(org.bukkit.command.CommandSender source, java.lang.String filter)
    Checks permissions and throws an exception if permission is not met.
    static org.bukkit.entity.Player matchSinglePlayer​(org.bukkit.command.CommandSender sender, java.lang.String filter)
    Match only a single player.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • matchPlayerNames

      public static java.util.List<org.bukkit.entity.Player> matchPlayerNames​(org.bukkit.command.CommandSender source, java.lang.String filter)
      Match player names.
      Parameters:
      source -
      filter -
      Returns:
    • matchPlayers

      public static java.util.List<org.bukkit.entity.Player> matchPlayers​(org.bukkit.command.CommandSender source, java.lang.String filter) throws com.sk89q.minecraft.util.commands.CommandException
      Checks permissions and throws an exception if permission is not met.
      Parameters:
      source -
      filter -
      Returns:
      iterator for players
      Throws:
      com.sk89q.minecraft.util.commands.CommandException - no matches found
    • matchPlayerExactly

      public static org.bukkit.entity.Player matchPlayerExactly​(org.bukkit.command.CommandSender sender, java.lang.String filter) throws com.sk89q.minecraft.util.commands.CommandException
      Match a single player exactly.
      Parameters:
      sender -
      filter -
      Returns:
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • matchSinglePlayer

      public static org.bukkit.entity.Player matchSinglePlayer​(org.bukkit.command.CommandSender sender, java.lang.String filter) throws com.sk89q.minecraft.util.commands.CommandException
      Match only a single player.
      Parameters:
      sender -
      filter -
      Returns:
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • matchPlayerOrConsole

      public static org.bukkit.command.CommandSender matchPlayerOrConsole​(org.bukkit.command.CommandSender sender, java.lang.String filter) throws com.sk89q.minecraft.util.commands.CommandException
      Match only a single player or console.
      Parameters:
      sender -
      filter -
      Returns:
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • detectTargets

      public static java.lang.Iterable<org.bukkit.entity.Player> detectTargets​(org.bukkit.command.CommandSender sender, com.sk89q.minecraft.util.commands.CommandContext args, java.lang.String perm) throws com.sk89q.minecraft.util.commands.CommandException
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • checkPlayerMatch

      @Deprecated public static java.util.List<org.bukkit.entity.Player> checkPlayerMatch​(java.util.List<org.bukkit.entity.Player> players) throws com.sk89q.minecraft.util.commands.CommandException
      Deprecated.
      Checks if the given list of players is greater than size 0, otherwise throw an exception.
      Parameters:
      players -
      Returns:
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • checkPlayerMatch

      public static <T extends java.util.Collection<? extends org.bukkit.entity.Player>> T checkPlayerMatch​(T players) throws com.sk89q.minecraft.util.commands.CommandException
      Checks if the given list of players is greater than size 0, otherwise throw an exception.
      Parameters:
      players -
      Returns:
      Throws:
      com.sk89q.minecraft.util.commands.CommandException
    • checkSinglePlayerMatch

      public static org.bukkit.entity.Player checkSinglePlayerMatch​(java.util.List<org.bukkit.entity.Player> players) throws com.sk89q.minecraft.util.commands.CommandException
      Checks if the given list of players contains only one player, otherwise throw an exception.
      Parameters:
      players -
      Returns:
      Throws:
      com.sk89q.minecraft.util.commands.CommandException