Package us.ajg0702.queue.api.events

Class BuildServersEvent

java.lang.Object
us.ajg0702.queue.api.events.BuildServersEvent
All Implemented Interfaces:
Event
public class BuildServersEvent extends Object implements Event
Called before AjQueue attempts to re-compile its list of QueueServers Use Case: Add/Remove an AdaptedServer from being registered as a QueueServer.

  • Constructor Details

    • BuildServersEvent

      public BuildServersEvent(List<? extends AdaptedServer> servers)

  • Method Details

    • getServers

      public List<AdaptedServer> getServers()
      Returns:
      an immutable view of the servers that will be registered as QueueServers.
      See Also:

    • addServer

      @Nullable public @Nullable AdaptedServer addServer(AdaptedServer server)
      Add a server to be registered as a QueueServer.
      Parameters:
      server - The server to add
      Returns:
      The previous AdaptedServer with that name, or null if there was no previous server

    • removeServer

      public boolean removeServer(AdaptedServer server)
      Remove a server, preventing it from being registered as a QueueServer.
      Parameters:
      server - The AdaptedServer to remove
      Returns:
      true if the server was removed, false if it was not found

    • removeServer

      public boolean removeServer(String name)
      Remove a server, preventing it from being registered as a QueueServer.
      Parameters:
      name - The name of the server to remove
      Returns:
      true if the server was removed, false if it was not found

    • getGroups

      public List<List<AdaptedServer>> getGroups()
      Returns:
      an immutable list of the sets of servers that will be registered as group QueueServers.
      See Also:

    • groupEntrySet

      public Set<Map.Entry<String,List<AdaptedServer>>> groupEntrySet()
      Used internally

    • addGroup

      @Nullable public @Nullable List<AdaptedServer> addGroup(String name, List<AdaptedServer> servers)
      Add a server-group to be registered by the Queue Manager.
      Parameters:
      name - The name of the server-group
      servers - The servers to add to the group
      Returns:
      The previous server list with that name, or null if there was no previous data

    • removeGroup

      public boolean removeGroup(String name)
      Remove a server, preventing it from being registered as a QueueServer.
      Parameters:
      name - The name of the server to remove
      Returns:
      true if the server was removed, false if it was not found