me.th3shad0wofdeath.countdown.api

Class CountdownManager

java.lang.Object

me.th3shad0wofdeath.countdown.api.CountdownManager

public final class CountdownManager
extends java.lang.Object

Controlls Countdown objects

Since:

1.0

Version:

1.2

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	addCountdown(Countdown countdown)
static Countdown	getCountdown(java.lang.String name, CountdownPlugin countdownPlugin)
static java.util.ArrayList<Countdown>	getCountdownList(CountdownPlugin countdownPlugin)
static int	pauseCountdown(Countdown countdown, CountdownPlugin countdownPlugin)
static boolean	registerListener(CountdownPlugin countdownPlugin, CountdownListener listener)
static int	removeCountdown(Countdown countdown, CountdownPlugin countdownPlugin)
static int	resumeCountdown(Countdown countdown, CountdownPlugin countdownPlugin)
static int	startCountdown(Countdown countdown, CountdownPlugin countdownPlugin)
static int	stopCountdown(Countdown countdown, CountdownPlugin countdownPlugin)
static boolean	unregisterListener(CountdownPlugin countdownPlugin, CountdownListener listener)

Methods inherited from class java.lang.Object

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

Method Detail

registerListener

public static boolean registerListener(CountdownPlugin countdownPlugin,
                       CountdownListener listener)

Parameters:

listener - to register

Returns:

true if the listener has been registered successfully, otherwise false

Since:

1.0

unregisterListener

public static boolean unregisterListener(CountdownPlugin countdownPlugin,
                         CountdownListener listener)

Parameters:

listener - to unregister

Returns:

true if the listener has been unregistered successfully, otherwise false

Since:

1.0

getCountdown

public static Countdown getCountdown(java.lang.String name,
                     CountdownPlugin countdownPlugin)
                              throws NotTheOwningPluginException

Parameters:

name - of the countdown

countdownPlugin - that owns the countdown

Returns:

the countdown, if a countdown with the name exists and the countdownPlugin is the owner of this countdown, otherwise null

Throws:

NotTheOwningPluginException - thrown if the countdownPlugin is not the owner of the countdown

Since:

1.0

getCountdownList

public static java.util.ArrayList<Countdown> getCountdownList(CountdownPlugin countdownPlugin)

Parameters:

countdownPlugin - that owns the countdown(s)

Returns:

an arraylist containing all owned Countdowns of the countdownPlugin

Since:

1.0

addCountdown

public static boolean addCountdown(Countdown countdown)

Parameters:

countdown - to add

Returns:

true if the countdown has been added successfully, otherwise false

Since:

1.0

removeCountdown

public static int removeCountdown(Countdown countdown,
                  CountdownPlugin countdownPlugin)

Parameters:

countdown - to remove

countdownPlugin - to check if the plugin is allowed to remove the countdown

Returns:

• 1 - removed successfully
• 0 - countdown could not be found
• -1 - owningPlugin is not allowed to remove this countdown

Since:

1.0

startCountdown

public static int startCountdown(Countdown countdown,
                 CountdownPlugin countdownPlugin)

Parameters:

countdown - to start

owningPlugin - to check if the plugin is allowed to start the countdown

Returns:

• 1 - started successfully
• 0 - the countdown is already running
• -1 - the countdownPlugin is not allowed to start this countdown
• -3 - the countdown is not registered

Since:

1.0

stopCountdown

public static int stopCountdown(Countdown countdown,
                CountdownPlugin countdownPlugin)

Parameters:

countdown - to stop

countdownPlugin - to check if the plugin is allowed to stop the countdown

Returns:

• 1 - stopped successfully
• 0 - the countdown is not running
• -1 - the countdownPlugin is not allowed to stop this countdown
• -3 - the countdown is not registered

Since:

1.0

pauseCountdown

public static int pauseCountdown(Countdown countdown,
                 CountdownPlugin countdownPlugin)

Parameters:

countdown - to pause

countdownPlugin - to check if the plugin is allowed to pause the countdown

Returns:

• 1 - paused successfully
• 0 - the countdown is already paused
• -1 - the countdownPlugin is not allowed to pause this countdown
• -2 - the countdown is not running
• -3 - the countdown is not registered

Since:

1.0

resumeCountdown

public static int resumeCountdown(Countdown countdown,
                  CountdownPlugin countdownPlugin)

Parameters:

countdown - to resume

countdownPlugin - to check if the plugin is allowed to resume the countdown

Returns:

• 1 - resumed successfully
• 0 - the countdown is not paused
• -1 - the countdownPlugin is not allowed to resume this countdown
• -2 - the countdown is not running
• -3 - the countdown is not registered

Since:

1.0