me.lucko.helper.utils

Class Cooldown

java.lang.Object

me.lucko.helper.utils.Cooldown

All Implemented Interfaces:

LongSupplier, Cooldown

Deprecated.

in favour of referencing Cooldown.

@Deprecated
 @NonnullByDefault
public class Cooldown
extends Object
implements LongSupplier, Cooldown

A simple cooldown abstraction

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastTested Deprecated.
protected long	timeout Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cooldown(long amount, TimeUnit unit) Deprecated.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

lastTested

protected long lastTested

Deprecated.

timeout

protected final long timeout

Deprecated.

Constructor Detail

Cooldown

@Deprecated
protected Cooldown(long amount,
                                TimeUnit unit)

Deprecated.

Method Detail

ofTicks

@Deprecated
public static Cooldown ofTicks(long ticks)

Deprecated.

Creates a cooldown lasting a number of game ticks

Specified by:

ofTicks in interface Cooldown

Parameters:

ticks - the number of ticks

Returns:

a new cooldown

of

@Deprecated
public static Cooldown of(long amount,
                                       TimeUnit unit)

Deprecated.

Creates a cooldown lasting a specified amount of time

Specified by:

of in interface Cooldown

Parameters:

amount - the amount of time

unit - the unit of time

Returns:

a new cooldown

test

public boolean test()

Deprecated.

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

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

Specified by:

test in interface Cooldown

Returns:

true if the cooldown is not active

testSilently

public boolean testSilently()

Deprecated.

Returns true if the cooldown is not active

Specified by:

testSilently in interface Cooldown

Returns:

true if the cooldown is not active

elapsed

public long elapsed()

Deprecated.

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

Specified by:

elapsed in interface Cooldown

Returns:

the elapsed time

reset

public void reset()

Deprecated.

Resets the cooldown

Specified by:

reset in interface Cooldown

remainingMillis

public long remainingMillis()

Deprecated.

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

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

Specified by:

remainingMillis in interface Cooldown

Returns:

the time in millis until the cooldown will expire

remainingTime

public long remainingTime(TimeUnit unit)

Deprecated.

Gets the time until the cooldown will become inactive.

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

Specified by:

remainingTime in interface Cooldown

Parameters:

unit - the unit to return in

Returns:

the time until the cooldown will expire

getAsLong

public long getAsLong()

Deprecated.

Specified by:

getAsLong in interface LongSupplier

getTimeout

public long getTimeout()

Deprecated.

Gets the timeout in milliseconds for this cooldown

Specified by:

getTimeout in interface Cooldown

Returns:

the timeout in milliseconds

copy

public Cooldown copy()

Deprecated.

Copies the properties of this cooldown to a new instance

Specified by:

copy in interface Cooldown

Returns:

a cloned cooldown instance

getLastTested

public OptionalLong getLastTested()

Deprecated.

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

Specified by:

getLastTested in interface Cooldown

Returns:

the last call time

setLastTested

public void setLastTested(long time)

Deprecated.

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.

Specified by:

setLastTested in interface Cooldown

Parameters:

time - the time