Package org.incendo.cloud.processors.cooldown

Interface CooldownConfiguration<C>

Type Parameters:

C - command sender type

All Known Implementing Classes:

ImmutableCooldownConfiguration

@Immutable
@API(status=STABLE,
     since="1.0.0")
public interface CooldownConfiguration<C>

Configuration for a CooldownManager.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
@NonNull List<CooldownActiveListener<C>>	activeCooldownListeners()	Returns the active cooldown listeners.
static <C> @NonNull ImmutableCooldownConfiguration.RepositoryBuildStage<C>	builder()	Returns a new configuration builder.
default @NonNull Predicate<@NonNull CommandContext<C>>	bypassCooldown()	Returns a predicate that determines whether the CommandContext should bypass the cooldown requirement.
default @NonNull Clock	clock()	Returns the clock used to calculate the current time.
@NonNull List<CooldownCreationListener<C>>	creationListeners()	Returns the creation listeners.
default @NonNull Function<@NonNull Command<C>,@NonNull CooldownGroup>	fallbackGroup()	Returns the function that determines the fallback CooldownGroup in case no group has been provided to the Cooldown.
default @NonNull CooldownProfileFactory	profileFactory()	Returns the factory that produces cooldown profiles.
@NonNull CooldownRepository<C>	repository()	Returns the repository used to store cooldowns.

Method Details

builder

static <C>
@NonNull ImmutableCooldownConfiguration.RepositoryBuildStage<C> builder()

Returns a new configuration builder.

Type Parameters:

C - command sender type

Returns:

the builder

repository

@NonNull CooldownRepository<C> repository()

Returns the repository used to store cooldowns.

Returns:

the repository

activeCooldownListeners

@NonNull List<CooldownActiveListener<C>> activeCooldownListeners()

Returns the active cooldown listeners.

The active cooldown listeners are invoked when a cooldown is preventing a sender from executing a command.

Returns:

active cooldown listeners

creationListeners

@NonNull List<CooldownCreationListener<C>> creationListeners()

Returns the creation listeners.

The creation listeners are invoked when a new cooldown is created.

Returns:

creation listeners

bypassCooldown

default @NonNull Predicate<@NonNull CommandContext<C>> bypassCooldown()

Returns a predicate that determines whether the CommandContext should bypass the cooldown requirement.

The default implementation always returns false

Returns:

predicate that determines whether cooldowns should be skipped

clock

default @NonNull Clock clock()

Returns the clock used to calculate the current time.

Returns:

the clock

profileFactory

default @NonNull CooldownProfileFactory profileFactory()

Returns the factory that produces cooldown profiles.

Returns:

cooldown profile factory

fallbackGroup

default @NonNull Function<@NonNull Command<C>,@NonNull CooldownGroup> fallbackGroup()

Returns the function that determines the fallback CooldownGroup in case no group has been provided to the Cooldown.

Returns:

the fallback group function