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 java.lang.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 Summary

Constructors

Constructor	Description
BuildServersEvent(java.util.List<? extends AdaptedServer> servers)

Method Summary

Modifier and Type	Method	Description
@Nullable java.util.List<AdaptedServer>	addGroup(java.lang.String name, java.util.List<AdaptedServer> servers)	Add a server-group to be registered by the Queue Manager.
@Nullable AdaptedServer	addServer(AdaptedServer server)	Add a server to be registered as a QueueServer.
java.util.List<java.util.List<AdaptedServer>>	getGroups()
java.util.List<AdaptedServer>	getServers()
java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<AdaptedServer>>>	groupEntrySet()	Used internally
boolean	removeGroup(java.lang.String name)	Remove a server, preventing it from being registered as a QueueServer.
boolean	removeServer(java.lang.String name)	Remove a server, preventing it from being registered as a QueueServer.
boolean	removeServer(AdaptedServer server)	Remove a server, preventing it from being registered as a QueueServer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildServersEvent

public BuildServersEvent(java.util.List<? extends AdaptedServer> servers)

Method Detail

getServers

public java.util.List<AdaptedServer> getServers()

Returns:

an immutable view of the servers that will be registered as QueueServers.

See Also:

addServer(AdaptedServer), removeServer(AdaptedServer), removeServer(String)

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(java.lang.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 java.util.List<java.util.List<AdaptedServer>> getGroups()

Returns:

an immutable list of the sets of servers that will be registered as group QueueServers.

See Also:

addGroup(String, List), removeGroup(String)

groupEntrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.util.List<AdaptedServer>>> groupEntrySet()

Used internally

addGroup

@Nullable
public @Nullable java.util.List<AdaptedServer> addGroup(java.lang.String name,
                                                        java.util.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(java.lang.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