Package org.incendo.cloud.processors.cooldown

Class CooldownManager<C>

java.lang.Object

org.incendo.cloud.processors.cooldown.CooldownManager<C>

Type Parameters:

C - command sender type

@API(status=STABLE,
     since="1.0.0")
public final class CooldownManager<C>
extends Object

Manager for the cooldown system.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final CloudKey<Cooldown<?>>	META_COOLDOWN_DURATION	Meta that adds the given cooldown to the command.

Method Summary

Modifier and Type	Method	Description
@NonNull CooldownConfiguration<C>	configuration()	Returns the configuration for this manager.
static <C> @NonNull CooldownManager<C>	cooldownManager(@NonNull Function<ImmutableCooldownConfiguration.RepositoryBuildStage<C>,ImmutableCooldownConfiguration.BuildFinal<C>> configuration)	Creates a new cooldown manager using the given configuration.
static <C> @NonNull CooldownManager<C>	cooldownManager(@NonNull CooldownConfiguration<C> configuration)	Creates a new cooldown manager using the given configuration.
@NonNull CommandPostprocessor<C>	createPostprocessor()	Returns a CommandPostprocessor that will prevent commands from executing if they are marked as needing confirmation.
@NonNull CooldownRepository<C>	repository()	Returns the cooldown repository.

Methods inherited from class java.lang.Object

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

Field Details

META_COOLDOWN_DURATION

public static final CloudKey<Cooldown<?>> META_COOLDOWN_DURATION

Meta that adds the given cooldown to the command.

Method Details

cooldownManager

public static <C> @NonNull CooldownManager<C> cooldownManager(@NonNull CooldownConfiguration<C> configuration)

Creates a new cooldown manager using the given configuration.

Type Parameters:

C - command sender type

Parameters:

configuration - configuration for the cooldown manager

Returns:

the created manager

cooldownManager

public static <C> @NonNull CooldownManager<C> cooldownManager(@NonNull Function<ImmutableCooldownConfiguration.RepositoryBuildStage<C>,ImmutableCooldownConfiguration.BuildFinal<C>> configuration)

Creates a new cooldown manager using the given configuration.

Type Parameters:

C - command sender type

Parameters:

configuration - configuration for the cooldown manager

Returns:

the created manager

configuration

public @NonNull CooldownConfiguration<C> configuration()

Returns the configuration for this manager.

Returns:

the configuration

repository

public @NonNull CooldownRepository<C> repository()

Returns the cooldown repository.

Returns:

the repository

createPostprocessor

public @NonNull CommandPostprocessor<C> createPostprocessor()

Returns a CommandPostprocessor that will prevent commands from executing if they are marked as needing confirmation.

Returns:

confirmation postprocessor