Class AbstractAsyncCommand

java.lang.Object

com.hypixel.hytale.server.core.command.system.AbstractCommand

com.hypixel.hytale.server.core.command.system.basecommands.AbstractAsyncCommand

Direct Known Subclasses:

AbstractAsyncPlayerCommand, AbstractAsyncWorldCommand, AbstractCommandCollection, AbstractPlayerCommand, AbstractTargetEntityCommand, AbstractTargetPlayerCommand, AbstractTargetPlayersCommand, AbstractWorldCommand, AssetsCommand.AssetLongestAssetNameCommand, AssetsDuplicatesCommand, BackupCommand, BanCommand, CancelCommand.CancelGlobalCommand, ConvertPrefabsCommand, GenerateI18nCommand, GiveArmorCommand, HelpCommand, InstanceEditCopyCommand, InstanceEditListCommand, InstanceEditLoadCommand, InstanceEditNewCommand, InstanceMigrateCommand, MacroCommandBase, StartCommand.StartGlobalCommand, UIGalleryCommand, UnbanCommand, UpdateCheckCommand, UpdateDownloadCommand, ValidateCPBCommand, WaitCommand, WhitelistAddCommand, WhitelistDisableCommand, WhitelistEnableCommand, WhitelistRemoveCommand, WhoCommand, WorldAddCommand, WorldPruneCommand, WorldSaveCommand

public abstract class AbstractAsyncCommand
extends AbstractCommand

An abstract command class for commands that run asynchronously.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractCommand

AbstractCommand.SuggestionOverrideEntry

Field Summary

Fields inherited from class AbstractCommand

EMPTY_STRING_ARRAY, LOGGER

Constructor Summary

Constructors

Constructor	Description
AbstractAsyncCommand(String description)	Variant Constructor for an AbstractAsyncCommand instance.
AbstractAsyncCommand(String name, String description)	Default Constructor for an AbstractAsyncCommand instance.
AbstractAsyncCommand(String name, String description, boolean requiresConfirmation)	Constructor for an AbstractAsyncCommand instance.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	runAsync(CommandContext context, Runnable runnable, Executor executor)	A method for simplifying the syntax of running certain async tasks.

Methods inherited from class AbstractCommand

acceptCall, addAliases, addSubCommand, addUsageVariant, completeRegistration, countParents, getAliases, getDescription, getFullyQualifiedName, getName, getOptionalArgument, getOptionalArguments, getOwner, getPermission, getPermissionGroups, getPermissionGroupsRecursive, getRequiredArguments, getSubCommand, getSubCommands, getSuggestionOverrides, getUsageShort, getUsageString, getVariantByArgCount, getVariantCommands, hasBeenRegistered, hasPermission, isVariant, matches, putRecursivePermissionGroups, requireNoPermission, requirePermission, requirePermission, setAllowsExtraArguments, setOwner, withDefaultArg, withDefaultArg, withFlagArg, withListDefaultArg, withListOptionalArg, withListRequiredArg, withOptionalArg, withOptionalArg, withRequiredArg, withRequiredArg

Methods inherited from class Object

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

Constructor Details

AbstractAsyncCommand

public AbstractAsyncCommand(@Nonnull
 String name,
 @Nonnull
 String description)

Default Constructor for an AbstractAsyncCommand instance.

Parameters:

name - The name of the command.

description - The description of the command.

AbstractAsyncCommand

public AbstractAsyncCommand(@Nonnull
 String name,
 @Nonnull
 String description,
 boolean requiresConfirmation)

Constructor for an AbstractAsyncCommand instance.

Parameters:

name - The name of the command.

description - The description of the command.

requiresConfirmation - Whether a confirmation parameter is required to execute.

AbstractAsyncCommand

public AbstractAsyncCommand(@Nonnull
 String description)

Variant Constructor for an AbstractAsyncCommand instance.

Parameters:

description - The description of the command.

Method Details

runAsync

@Nonnull
public CompletableFuture<Void> runAsync(@Nonnull
 CommandContext context,
 @Nonnull
 Runnable runnable,
 @Nonnull
 Executor executor)

A method for simplifying the syntax of running certain async tasks.

Parameters:

context - The CommandContext passed by the execute method

runnable - A Runnable to be run asynchronously

executor - The Executor to execute this task on

Returns:

An incomplete CompletableFuture<Void> that runs the Runnable on the Executor