Package org.incendo.cloud.processors.confirmation

Class ConfirmationManager<C>

java.lang.Object

org.incendo.cloud.processors.confirmation.ConfirmationManager<C>

Type Parameters:

C - command sender type

All Implemented Interfaces:

Command.Builder.Applicable<C>

@API(status=STABLE,
     since="1.0.0")
public final class ConfirmationManager<C>
extends Object
implements Command.Builder.Applicable<C>

Manager for the confirmation system.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final CloudKey<Boolean>	META_CONFIRMATION_REQUIRED	CommandMeta key that indicates that the command requires a confirmation to be executed.

Method Summary

Modifier and Type	Method	Description
@NonNull Command.Builder<C>	applyToCommandBuilder(@NonNull Command.Builder<C> builder)	Applies the META_CONFIRMATION_REQUIRED meta key to the given builder.
@NonNull ConfirmationConfiguration<C>	configuration()	Returns the configuration for this manager.
static <C> @NonNull ConfirmationManager<C>	confirmationManager(@NonNull Function<@NonNull ImmutableConfirmationConfiguration.CacheBuildStage<C>,@NonNull ImmutableConfirmationConfiguration.BuildFinal<C>> configuration)	Creates a new confirmation manager using the given configuration.
static <C> @NonNull ConfirmationManager<C>	confirmationManager(@NonNull ConfirmationConfiguration<C> configuration)	Creates a new confirmation manager using the given configuration.
@NonNull CommandExecutionHandler<C>	createExecutionHandler()	Returns a CommandExecutionHandler that will execute the pending command for the command sender, or invoke the ConfirmationConfiguration.noPendingCommandNotifier().
@NonNull CommandPostprocessor<C>	createPostprocessor()	Returns a CommandPostprocessor that will prevent commands from executing if they are marked as needing confirmation.
@NonNull Optional<ConfirmationContext<C>>	popPending(@NonNull C sender)	Removes the ConfirmationContext stored for the given sender and returns it.

Methods inherited from class java.lang.Object

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

Field Details

META_CONFIRMATION_REQUIRED

public static final CloudKey<Boolean> META_CONFIRMATION_REQUIRED

CommandMeta key that indicates that the command requires a confirmation to be executed.

Method Details

confirmationManager

public static <C> @NonNull ConfirmationManager<C> confirmationManager(@NonNull ConfirmationConfiguration<C> configuration)

Creates a new confirmation manager using the given configuration.

Type Parameters:

C - command sender type

Parameters:

configuration - configuration for the confirmation manager

Returns:

the created manager

confirmationManager

public static <C> @NonNull ConfirmationManager<C> confirmationManager(@NonNull Function<@NonNull ImmutableConfirmationConfiguration.CacheBuildStage<C>,@NonNull ImmutableConfirmationConfiguration.BuildFinal<C>> configuration)

Creates a new confirmation manager using the given configuration.

Type Parameters:

C - command sender type

Parameters:

configuration - configuration for the confirmation manager

Returns:

the created manager

configuration

public @NonNull ConfirmationConfiguration<C> configuration()

Returns the configuration for this manager.

Returns:

the configuration

applyToCommandBuilder

public @NonNull Command.Builder<C> applyToCommandBuilder(@NonNull Command.Builder<C> builder)

Applies the META_CONFIRMATION_REQUIRED meta key to the given builder.

Specified by:

applyToCommandBuilder in interface Command.Builder.Applicable<C>

Parameters:

builder - builder to decorate

Returns:

the decorated builder

createExecutionHandler

public @NonNull CommandExecutionHandler<C> createExecutionHandler()

Returns a CommandExecutionHandler that will execute the pending command for the command sender, or invoke the ConfirmationConfiguration.noPendingCommandNotifier().

Returns:

confirmation execution handler

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

popPending

public @NonNull Optional<ConfirmationContext<C>> popPending(@NonNull C sender)

Removes the ConfirmationContext stored for the given sender and returns it.

Parameters:

sender - command sender

Returns:

optional containing the value if it exists and has not yet expired