Package org.mvplugins.multiverse.core.utils

Class PlayerFinder

java.lang.Object
org.mvplugins.multiverse.core.utils.PlayerFinder
public final class PlayerFinder extends Object
Helper class to get Player from name, UUID or Selectors.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerFinder()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable org.bukkit.entity.Player
    get(@Nullable String playerIdentifier)
    Get a Player based on an identifier of name UUID or selector.
    static @Nullable org.bukkit.entity.Player
    get(@Nullable String playerIdentifier, @NotNull org.bukkit.command.CommandSender sender)
    Get a Player based on an identifier of name UUID or selector.
    static @Nullable org.bukkit.entity.Player
    getByName(@NotNull String playerName)
    Get a Player based on player name.
    static @Nullable org.bukkit.entity.Player
    getBySelector(@NotNull String playerSelector, @NotNull org.bukkit.command.CommandSender sender)
    Get a Player based on vanilla selectors.
    static @Nullable org.bukkit.entity.Player
    getByUuid(@NotNull String playerUuid)
    Get a Player based on player UUID.
    static @Nullable org.bukkit.entity.Player
    getByUuid(@NotNull UUID playerUuid)
    Get a Player based on playerUUID.
    static @NotNull List<org.bukkit.entity.Player>
    getMulti(@Nullable String playerIdentifiers)
    Get multiple Player based on many identifiers of name UUID or selector.
    static @NotNull List<org.bukkit.entity.Player>
    getMulti(@Nullable String playerIdentifiers, @NotNull org.bukkit.command.CommandSender sender)
    Get multiple Player based on many identifiers of name UUID or selector.
    static @NotNull List<org.bukkit.entity.Player>
    getMultiBySelector(@NotNull String playerSelector, @NotNull org.bukkit.command.CommandSender sender)
    Get multiple Player based on vanilla selectors.
    static boolean
    isSelector(@NotNull String playerIdentifier)
    Check if the player identifier is a selector.
    static @NotNull io.vavr.control.Try<@NotNull List<org.bukkit.entity.Player>>
    tryGetMulti(@Nullable String playerIdentifiers, @NotNull org.bukkit.command.CommandSender sender)
    Get multiple Player based on many identifiers of name UUID or selector.
    static @NotNull io.vavr.control.Try<@NotNull List<org.bukkit.entity.Player>>
    tryGetMultiBySelector(@NotNull String playerSelector, @NotNull org.bukkit.command.CommandSender sender)
    Get multiple Player based on vanilla selectors.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PlayerFinder

      public PlayerFinder()

  • Method Details

    • get

      @Nullable public static @Nullable org.bukkit.entity.Player get(@Nullable @Nullable String playerIdentifier)
      Get a Player based on an identifier of name UUID or selector.
      Parameters:
      playerIdentifier - An identifier of name UUID or selector.
      Returns:
      The player if found, else null.

    • get

      @Nullable public static @Nullable org.bukkit.entity.Player get(@Nullable @Nullable String playerIdentifier, @NotNull @NotNull org.bukkit.command.CommandSender sender)
      Get a Player based on an identifier of name UUID or selector.
      Parameters:
      playerIdentifier - An identifier of name UUID or selector.
      sender - Target sender for selector.
      Returns:
      The player if found, else null.

    • getMulti

      @NotNull public static @NotNull List<org.bukkit.entity.Player> getMulti(@Nullable @Nullable String playerIdentifiers)
      Get multiple Player based on many identifiers of name UUID or selector.
      Parameters:
      playerIdentifiers - An identifier of multiple names, UUIDs or selectors, separated by comma.
      Returns:
      A list of all the Player found.

    • getMulti

      @NotNull public static @NotNull List<org.bukkit.entity.Player> getMulti(@Nullable @Nullable String playerIdentifiers, @NotNull @NotNull org.bukkit.command.CommandSender sender)
      Get multiple Player based on many identifiers of name UUID or selector.
      Parameters:
      playerIdentifiers - An identifier of multiple names, UUIDs or selectors, separated by comma.
      sender - Target sender for selector.
      Returns:
      A list of all the Player found.

    • tryGetMulti

      @AvailableSince("5.4") @NotNull public static @NotNull io.vavr.control.Try<@NotNull List<org.bukkit.entity.Player>> tryGetMulti(@Nullable @Nullable String playerIdentifiers, @NotNull @NotNull org.bukkit.command.CommandSender sender)
      Get multiple Player based on many identifiers of name UUID or selector.
      Parameters:
      playerIdentifiers - An identifier of multiple names, UUIDs or selectors, separated by comma.
      sender - Target sender for selector.
      Returns:
      A list of all the Player found.
      Since:
      5.4

    • isSelector

      @AvailableSince("5.4") public static boolean isSelector(@NotNull @NotNull String playerIdentifier)
      Check if the player identifier is a selector.
      Parameters:
      playerIdentifier - An identifier of name, UUID or selector.
      Returns:
      True if the identifier is a selector, else false.
      Since:
      5.4

    • getByName

      @Nullable public static @Nullable org.bukkit.entity.Player getByName(@NotNull @NotNull String playerName)
      Get a Player based on player name.
      Parameters:
      playerName - Name of a Player.
      Returns:
      The player if found, else null.

    • getByUuid

      @Nullable public static @Nullable org.bukkit.entity.Player getByUuid(@NotNull @NotNull String playerUuid)
      Get a Player based on player UUID.
      Parameters:
      playerUuid - UUID of a player.
      Returns:
      The player if found, else null.

    • getByUuid

      @Nullable public static @Nullable org.bukkit.entity.Player getByUuid(@NotNull @NotNull UUID playerUuid)
      Get a Player based on playerUUID.
      Parameters:
      playerUuid - UUID of a player.
      Returns:
      The player if found, else null.

    • getBySelector

      @Nullable public static @Nullable org.bukkit.entity.Player getBySelector(@NotNull @NotNull String playerSelector, @NotNull @NotNull org.bukkit.command.CommandSender sender)
      Get a Player based on vanilla selectors.
      Parameters:
      playerSelector - A target selector, usually starts with an '@'.
      sender - Target sender for selector.
      Returns:
      The player if only one found, else null.

    • getMultiBySelector

      @NotNull public static @NotNull List<org.bukkit.entity.Player> getMultiBySelector(@NotNull @NotNull String playerSelector, @NotNull @NotNull org.bukkit.command.CommandSender sender)
      Get multiple Player based on vanilla selectors.
      Parameters:
      playerSelector - A target selector, usually starts with an '@'.
      sender - Target sender for selector.
      Returns:
      A list of all the Player found.

    • tryGetMultiBySelector

      @AvailableSince("5.4") @NotNull public static @NotNull io.vavr.control.Try<@NotNull List<org.bukkit.entity.Player>> tryGetMultiBySelector(@NotNull @NotNull String playerSelector, @NotNull @NotNull org.bukkit.command.CommandSender sender)
      Get multiple Player based on vanilla selectors.
      Parameters:
      playerSelector - A target selector, usually starts with an '@'.
      sender - Target sender for selector.
      Returns:
      A list of all the Player found.
      Since:
      5.4