Package us.ajg0702.queue.api

Class AjQueueAPI

java.lang.Object

us.ajg0702.queue.api.AjQueueAPI

public abstract class AjQueueAPI
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static AjQueueAPI	INSTANCE
static PermissionHookRegistry	permissionHookRegistry
static QueueHolderRegistry	queueHolderRegistry
static AjQueueSpigotAPI	SPIGOT_INSTANCE

Constructor Summary

Constructors

Constructor	Description
AjQueueAPI()

Method Summary

Modifier and Type	Method	Description
abstract AliasManager	getAliasManager()	Gets the alias manager.
abstract us.ajg0702.utils.common.Config	getConfig()	Gets the ajQueue config
abstract EventHandler	getEventHandler()	Gets the event handler.
static AjQueueAPI	getInstance()	Gets the instance of the ajQueue API
abstract QueueLogger	getLogger()	Gets the ajQueue logger.
abstract Logic	getLogic()	Gets the priority logic.
abstract LogicGetter	getLogicGetter()	Gets the logic getter.
abstract us.ajg0702.utils.common.Messages	getMessages()	Gets the ajQueue messages manager
static PermissionHookRegistry	getPermissionHookRegistry()
abstract PlatformMethods	getPlatformMethods()	Gets the PlatformMethods for the platform (e.g.
abstract ProtocolNameManager	getProtocolNameManager()	Gets the protocol name manager Used to get version names from protocol versions
static QueueHolderRegistry	getQueueHolderRegistry()
abstract QueueManager	getQueueManager()	Gets the queue manager.
abstract java.util.concurrent.ExecutorService	getServersUpdateExecutor()
abstract ServerTimeManager	getServerTimeManager()	Gets the server time manager instance, which tracks when players last changed servers
static AjQueueSpigotAPI	getSpigotInstance()
abstract double	getTimeBetweenPlayers()	Gets the time that ajQueue will wait between sending players.
abstract boolean	isPremium()	Checks if the plugin is the premium version or not.
abstract <E> void	listen(java.lang.Class<E> event, EventReceiver<E> handler)
abstract void	setTimeBetweenPlayers()	Updates the time between players.
abstract void	shutdown()	Tells ajQueue to shut down.

Methods inherited from class java.lang.Object

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

Field Detail

queueHolderRegistry

public static QueueHolderRegistry queueHolderRegistry

permissionHookRegistry

public static PermissionHookRegistry permissionHookRegistry

INSTANCE

public static AjQueueAPI INSTANCE

SPIGOT_INSTANCE

public static AjQueueSpigotAPI SPIGOT_INSTANCE

Constructor Detail

AjQueueAPI

public AjQueueAPI()

Method Detail

getInstance

public static AjQueueAPI getInstance()

Gets the instance of the ajQueue API

Returns:

the ajQueue API

getSpigotInstance

public static AjQueueSpigotAPI getSpigotInstance()

getTimeBetweenPlayers

public abstract double getTimeBetweenPlayers()

Gets the time that ajQueue will wait between sending players. In seconds

Returns:

The time, in seconds, ajQueue will wait between attempting to send players

setTimeBetweenPlayers

public abstract void setTimeBetweenPlayers()

Updates the time between players. Takes it from the config.

getServerTimeManager

public abstract ServerTimeManager getServerTimeManager()

Gets the server time manager instance, which tracks when players last changed servers

Returns:

The server time manager instance

getConfig

public abstract us.ajg0702.utils.common.Config getConfig()

Gets the ajQueue config

Returns:

the ajQueue config

getMessages

public abstract us.ajg0702.utils.common.Messages getMessages()

Gets the ajQueue messages manager

Returns:

the messages manager

getAliasManager

public abstract AliasManager getAliasManager()

Gets the alias manager. Used to get aliases of servers set in ajqueue's config. Note that the alias manager on the free version will just return the server's name

Returns:

The alias manager

getLogic

public abstract Logic getLogic()

Gets the priority logic. Note that the priority logic for the free version does nothing.

Returns:

The priority logic

isPremium

public abstract boolean isPremium()

Checks if the plugin is the premium version or not.

Returns:

True if ajQueuePlus, false if ajQueue

getPlatformMethods

public abstract PlatformMethods getPlatformMethods()

Gets the PlatformMethods for the platform (e.g. bungee, velocity) The methods in this class do things that the code for each is different on the platform.

Returns:

the PlatformMethods

getLogger

public abstract QueueLogger getLogger()

Gets the ajQueue logger. If you are using this, please add your own prefix to it.

Returns:

The ajQueue logger

getEventHandler

public abstract EventHandler getEventHandler()

Gets the event handler. This class will probably be replaced in the future with an actual event system

Returns:

the EventHandler

getQueueManager

public abstract QueueManager getQueueManager()

Gets the queue manager. Most things you do interacting with queues will be through this.

Returns:

the QueueManager

getLogicGetter

public abstract LogicGetter getLogicGetter()

Gets the logic getter.

Returns:

The logic getter

getProtocolNameManager

public abstract ProtocolNameManager getProtocolNameManager()

Gets the protocol name manager Used to get version names from protocol versions

Returns:

The ProtocolNameManager

shutdown

public abstract void shutdown()

Tells ajQueue to shut down.

getQueueHolderRegistry

public static QueueHolderRegistry getQueueHolderRegistry()

getPermissionHookRegistry

public static PermissionHookRegistry getPermissionHookRegistry()

listen

public abstract <E> void listen(java.lang.Class<E> event,
                                EventReceiver<E> handler)

getServersUpdateExecutor

public abstract java.util.concurrent.ExecutorService getServersUpdateExecutor()