me.lucko.helper.cooldown

Interface CooldownMap<T>

Type Parameters:

T - the type

public interface CooldownMap<T>

A self-populating map of cooldown instances

Method Summary

Modifier and Type	Method and Description
static <T> CooldownMap<T>	create(Cooldown base) Creates a new collection with the cooldown properties defined by the base instance
default long	elapsed(T key)
Cooldown	get(T key) Gets the internal cooldown instance associated with the given key.
Map<T,Cooldown>	getAll() Gets the cooldowns contained within this collection.
Cooldown	getBase() Gets the base cooldown
default OptionalLong	getLastTested(T key)
void	put(T key, Cooldown cooldown)
default long	remainingMillis(T key)
default long	remainingTime(T key, TimeUnit unit)
default void	reset(T key)
default void	setLastTested(T key, long time)
default boolean	test(T key)
default boolean	testSilently(T key)

Method Detail

create

@Nonnull
static <T> CooldownMap<T> create(@Nonnull
                                          Cooldown base)

Creates a new collection with the cooldown properties defined by the base instance

Parameters:

base - the cooldown to base off

Returns:

a new collection

getBase

@Nonnull
Cooldown getBase()

Gets the base cooldown

Returns:

the base cooldown

get

@Nonnull
Cooldown get(@Nonnull
                      T key)

Gets the internal cooldown instance associated with the given key.

The inline Cooldown methods in this class should be used to access the functionality of the cooldown as opposed to calling the methods directly via the instance returned by this method.

Parameters:

key - the key

Returns:

a cooldown instance

put

void put(@Nonnull
         T key,
         @Nonnull
         Cooldown cooldown)

getAll

@Nonnull
Map<T,Cooldown> getAll()

Gets the cooldowns contained within this collection.

Returns:

the backing map

test

default boolean test(@Nonnull
                     T key)

testSilently

default boolean testSilently(@Nonnull
                             T key)

elapsed

default long elapsed(@Nonnull
                     T key)

reset

default void reset(@Nonnull
                   T key)

remainingMillis

default long remainingMillis(@Nonnull
                             T key)

remainingTime

default long remainingTime(@Nonnull
                           T key,
                           @Nonnull
                           TimeUnit unit)

getLastTested

@Nonnull
default OptionalLong getLastTested(@Nonnull
                                            T key)

setLastTested

default void setLastTested(@Nonnull
                           T key,
                           long time)