me.lucko.helper.cooldown

Interface ComposedCooldownMap<I,O>

Type Parameters:

I - input type

O - internal type

public interface ComposedCooldownMap<I,O>

A self-populating, composed map of cooldown instances

Method Summary

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

Method Detail

create

@Nonnull
static <I,O> ComposedCooldownMap<I,O> create(@Nonnull
                                                      Cooldown base,
                                                      @Nonnull
                                                      Function<I,O> composeFunction)

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
                      I key)

Gets the internal cooldown instance associated with the given key

Parameters:

key - the key

Returns:

a cooldown instance

put

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

getAll

@Nonnull
Map<O,Cooldown> getAll()

Gets the cooldowns contained within this collection.

Returns:

the backing map

test

boolean test(@Nonnull
             I key)

testSilently

boolean testSilently(@Nonnull
                     I key)

elapsed

long elapsed(@Nonnull
             I key)

reset

void reset(@Nonnull
           I key)

remainingMillis

long remainingMillis(@Nonnull
                     I key)

remainingTime

long remainingTime(@Nonnull
                   I key,
                   @Nonnull
                   TimeUnit unit)

getLastTested

@Nonnull
OptionalLong getLastTested(@Nonnull
                                    I key)