Package us.ajg0702.queue.api.queueholders

Class QueueHolder

java.lang.Object
us.ajg0702.queue.api.queueholders.QueueHolder
public abstract class QueueHolder extends Object

  • Constructor Details

    • QueueHolder

      public QueueHolder(QueueServer queueServer)

  • Method Details

    • getIdentifier

      public abstract String getIdentifier()
      Returns the identifier of this QueueHolder Used by the server owner in order to tell ajQueue to use this QueueHolder
      Returns:
      a string that is very unlikely to be re-used by another QueueHolder

    • addPlayer

      public abstract void addPlayer(QueuePlayer player)
      Adds a player to the end of the queue NOTE: Do not manually call this! Use the QueueManager to add players to queues
      Parameters:
      player - The QueuePlayer to add

    • addPlayer

      public abstract void addPlayer(QueuePlayer player, int position)
      Adds a player to the specified position in the queue NOTE: Do not manually call this! Use the QueueManager to add players to queues
      Parameters:
      player - The QueuePlayer to add
      position - The position to add them to

    • removePlayer

      public void removePlayer(AdaptedPlayer player)

    • removePlayer

      public void removePlayer(UUID uuid)

    • removePlayer

      public abstract void removePlayer(QueuePlayer player)
      Removes a player from the queue
      Parameters:
      player - The player to remove

    • findPlayer

      public abstract QueuePlayer findPlayer(UUID uuid)
      Finds the player with this uuid in this queue and returns the representative QueuePlayer
      Returns:
      The QueuePlayer representing the player, null if not found

    • findPlayer

      public abstract QueuePlayer findPlayer(String name)
      Finds the player with this username in this queue and returns the representative QueuePlayer
      Returns:
      The QueuePlayer representing the player, null if not found

    • findPlayer

      public QueuePlayer findPlayer(AdaptedPlayer player)

    • getStandardQueueSize

      public abstract int getStandardQueueSize()
      Returns the size of the standard queue
      Returns:
      The number of players in the standard queue

    • getExpressQueueSize

      public abstract int getExpressQueueSize()
      Returns the size of the express queue
      Returns:
      The number of players in the express queue

    • getTotalQueueSize

      public abstract int getTotalQueueSize()
      Gets the size of both the express and standard queues combines
      Returns:
      the number of players in both queues

    • getTotalOnlineQueueSize

      public abstract int getTotalOnlineQueueSize()
      Gets the number of players in both express and standard queues combined, but only ones that are online
      Returns:
      The number of online players in both queues.

    • getPosition

      public abstract int getPosition(QueuePlayer player)

    • getAllStandardPlayers

      public abstract List<QueuePlayer> getAllStandardPlayers()
      Get all players that are in the standard queue
      Returns:
      a list of players in the standard queue

    • getAllExpressPlayers

      public abstract List<QueuePlayer> getAllExpressPlayers()
      Get all players that are in the express queue
      Returns:
      a list of players in the express queue

    • getAllPlayers

      public List<QueuePlayer> getAllPlayers()
      Gets all players that are in all queues for this server
      Returns:
      a list of all players. Express queue players are first in the list, then standard queue players.