com.codelanx.codelanxlib.util

Class Countdown

java.lang.Object

com.codelanx.codelanxlib.util.Countdown

public class Countdown
extends Object

Allows for having a countdown timer which can be applied through messages or one of Bukkit's Scoreboard objects. Additionally, can run code provided through the start(long, Runnable) method

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Constructor Summary

Constructors

Constructor and Description
Countdown()

Method Summary

Modifier and Type	Method and Description
Countdown	announceAt(long time, TimeUnit unit) Notes to make a chat-based announcement at the specified time in the countdown
Countdown	announceAt(com.codelanx.commons.util.time.TimePoint point) Notes to make a chat-based announcement at the specified time in the countdown
Countdown	announceAtRange(long min, long max, TimeUnit unit) Sets an announcement at every single integer point between the specified max and min values, inclusively.
Countdown	assignScoreboard(Scoreboard s) Assigns a scoreboard to have the objective in the DisplaySlot.SIDEBAR's title changed in accordance to the default format
Countdown	assignScoreboard(Scoreboard s, String format) Assigns a scoreboard to have the objective in the DisplaySlot.SIDEBAR's title changed in accordance to the format given to this specific board.
String	getDefaultFormat() Returns the default format used for all boards
Countdown	setAnnouncementFormat(String format) Sets the format for announcement messages in the chat from this Countdown.
Countdown	setTimeFormat(String format) Sets the format for the title of the sidebar scoreboard.
void	start(long duration, Runnable exec) Starts a countdown timer that will run for as long as the specified duration argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

Countdown

public Countdown()

Method Detail

start

public void start(long duration,
                  Runnable exec)

Starts a countdown timer that will run for as long as the specified duration argument.

Parameters:

duration - The amount of time in seconds to run the countdown

exec - Task to run when countdown completes

Since:

0.1.0

assignScoreboard

public Countdown assignScoreboard(Scoreboard s,
                                  String format)

Assigns a scoreboard to have the objective in the DisplaySlot.SIDEBAR's title changed in accordance to the format given to this specific board.

Parameters:

s - The scoreboard to modify

format - Optional board-specific format. Can be null

Returns:

The current class instance (chaining)

Since:

0.1.0

See Also:

for info about the syntax for setting a format string

assignScoreboard

public Countdown assignScoreboard(Scoreboard s)

Assigns a scoreboard to have the objective in the DisplaySlot.SIDEBAR's title changed in accordance to the default format

Parameters:

s - The scoreboard to modify

Returns:

The current class instance (chaining)

Since:

0.1.0

setTimeFormat

public Countdown setTimeFormat(String format)

Sets the format for the title of the sidebar scoreboard. This format requires the format tokens (%s and %d), but if an additional %s is supplied it will use the first %d for displaying hours and the following for minutes and seconds. Additionally, %d should be the first token in the format string. So in practice:

.* %d .* %s (optional) .* %s .*

The actual regex in use to verify this formatting string is:
(?!.*%[^sd])(?!.*%d.*%d)(?!.*%s.*%s.*%s) (?!.*%s.*%d)(?=.*%s)(?=.*%d).*

Parameters:

format - The format for the clock

Returns:

The current Countdown object

Since:

0.1.0

setAnnouncementFormat

public Countdown setAnnouncementFormat(String format)

Sets the format for announcement messages in the chat from this Countdown.

Parameters:

format - The format to set

Returns:

The current instance (chained)

Since:

0.1.0

announceAt

public Countdown announceAt(long time,
                            TimeUnit unit)

Notes to make a chat-based announcement at the specified time in the countdown

Parameters:

time - The amount of time to announce at

unit - The relevant unit of time

Returns:

The current instance (chained)

Since:

0.1.0

announceAt

public Countdown announceAt(com.codelanx.commons.util.time.TimePoint point)

Notes to make a chat-based announcement at the specified time in the countdown

Parameters:

point - The relevant TimePoint to announce at

Returns:

The current instance (chained)

Since:

0.1.0

announceAtRange

public Countdown announceAtRange(long min,
                                 long max,
                                 TimeUnit unit)

Sets an announcement at every single integer point between the specified max and min values, inclusively. E.g. a call of announceAtRange.(5, 10, TimeUnit.MINUTES) would announce at every minute between 5 and 10, as well as those times themselves

Parameters:

min - The minimum time to announce at

max - The maximum time to announce at

unit - The unit of time relevant to this range

Returns:

The current instance (chained)

Since:

0.1.0

getDefaultFormat

public String getDefaultFormat()

Returns the default format used for all boards

Returns:

The default format

Since:

0.1.0