me.lucko.helper.cooldown

Interface Cooldown

All Superinterfaces:

GsonSerializable

public interface Cooldown
extends GsonSerializable

A simple cooldown abstraction

Method Summary

Modifier and Type	Method and Description
Cooldown	copy() Copies the properties of this cooldown to a new instance
static Cooldown	deserialize(com.google.gson.JsonElement element)
default long	elapsed() Returns the elapsed time in milliseconds since the cooldown was last reset, or since creation time
OptionalLong	getLastTested() Return the time in milliseconds when this cooldown was last test()ed.
long	getTimeout() Gets the timeout in milliseconds for this cooldown
static Cooldown	of(long amount, TimeUnit unit) Creates a cooldown lasting a specified amount of time
static Cooldown	ofTicks(long ticks) Creates a cooldown lasting a number of game ticks
default long	remainingMillis() Gets the time in milliseconds until the cooldown will become inactive.
default long	remainingTime(TimeUnit unit) Gets the time until the cooldown will become inactive.
default void	reset() Resets the cooldown
void	setLastTested(long time) Sets the time in milliseconds when this cooldown was last tested.
default boolean	test() Returns true if the cooldown is not active, and then resets the timer
default boolean	testSilently() Returns true if the cooldown is not active

Methods inherited from interface me.lucko.helper.gson.GsonSerializable

deserialize, deserializeRaw, getDeserializeMethod, serialize

Method Detail

deserialize

static Cooldown deserialize(com.google.gson.JsonElement element)

ofTicks

@Nonnull
static Cooldown ofTicks(long ticks)

Creates a cooldown lasting a number of game ticks

Parameters:

ticks - the number of ticks

Returns:

a new cooldown

of

@Nonnull
static Cooldown of(long amount,
                            @Nonnull
                            TimeUnit unit)

Creates a cooldown lasting a specified amount of time

Parameters:

amount - the amount of time

unit - the unit of time

Returns:

a new cooldown

test

default boolean test()

Returns true if the cooldown is not active, and then resets the timer

If the cooldown is currently active, the timer is not reset.

Returns:

true if the cooldown is not active

testSilently

default boolean testSilently()

Returns true if the cooldown is not active

Returns:

true if the cooldown is not active

elapsed

default long elapsed()

Returns the elapsed time in milliseconds since the cooldown was last reset, or since creation time

Returns:

the elapsed time

reset

default void reset()

Resets the cooldown

remainingMillis

default long remainingMillis()

Gets the time in milliseconds until the cooldown will become inactive.

If the cooldown is not active, this method returns 0.

Returns:

the time in millis until the cooldown will expire

remainingTime

default long remainingTime(TimeUnit unit)

Gets the time until the cooldown will become inactive.

If the cooldown is not active, this method returns 0.

Parameters:

unit - the unit to return in

Returns:

the time until the cooldown will expire

getLastTested

@Nonnull
OptionalLong getLastTested()

Return the time in milliseconds when this cooldown was last test()ed.

Returns:

the last call time

setLastTested

void setLastTested(long time)

Sets the time in milliseconds when this cooldown was last tested.

Note: this should only be used when re-constructing a cooldown instance. Use test() otherwise.

Parameters:

time - the time

getTimeout

long getTimeout()

Gets the timeout in milliseconds for this cooldown

Returns:

the timeout in milliseconds

copy

@Nonnull
Cooldown copy()

Copies the properties of this cooldown to a new instance

Returns:

a cloned cooldown instance