com.codelanx.codelanxlib.util

Class TimeUtil.Countdown

java.lang.Object

com.codelanx.codelanxlib.util.TimeUtil.Countdown

Enclosing class:

TimeUtil

public static class TimeUtil.Countdown
extends Object

Constructor Summary

Constructors

Constructor and Description
Countdown()

Method Summary

Modifier and Type	Method and Description
TimeUtil.Countdown	announceAt(long time, TimeUnit unit)
TimeUtil.Countdown	announceAt(TimeUtil.TimePoint point)
TimeUtil.Countdown	announceAtRange(long min, long max, TimeUnit unit)
TimeUtil.Countdown	assignScoreboard(org.bukkit.scoreboard.Scoreboard s) Assigns a scoreboard to have the objective in the DisplaySlot.SIDEBAR's title changed in accordance to the default format
TimeUtil.Countdown	assignScoreboard(org.bukkit.scoreboard.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
TimeUtil.Countdown	setAnnouncementFormat(String format)
TimeUtil.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 TimeUtil.Countdown assignScoreboard(org.bukkit.scoreboard.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 TimeUtil.Countdown assignScoreboard(org.bukkit.scoreboard.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 TimeUtil.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 TimeUtil.Countdown object

Since:

0.1.0

setAnnouncementFormat

public TimeUtil.Countdown setAnnouncementFormat(String format)

announceAt

public TimeUtil.Countdown announceAt(long time,
                                     TimeUnit unit)

announceAt

public TimeUtil.Countdown announceAt(TimeUtil.TimePoint point)

announceAtRange

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

getDefaultFormat

public String getDefaultFormat()

Returns the default format used for all boards

Returns:

The default format

Since:

0.1.0