com.datasiqn.commandcore.command

Interface Command

public interface Command

Represents a command

Method Summary

Modifier and Type	Method and Description
@NotNull com.datasiqn.resultapi.Result<com.datasiqn.resultapi.None,List<String>>	execute(CommandContext context) Executes this command executor
@NotNull String[]	getAliases() Gets the aliases of this command
@Nullable String	getDescription() Gets the description of this command
@NotNull String	getName() Gets this command's name
@Nullable String	getPermissionString() Gets the permission for this command, registered in the plugin.yml file
@NotNull List<String>	getUsages() Gets the usages for this command
boolean	hasDescription() Gets whether this command has a description or not
boolean	hasPermission() Gets whether this command has a permission or not
default @NotNull TabComplete	tabComplete(CommandContext context) Gets the tabcomplete for this command executor

Method Detail

getName

@NotNull
@NotNull String getName()

Gets this command's name

Returns:

The name

getAliases

@NotNull
@NotNull String[] getAliases()

Gets the aliases of this command

Returns:

The aliases

execute

@NotNull
@NotNull com.datasiqn.resultapi.Result<com.datasiqn.resultapi.None,List<String>> execute(CommandContext context)

Executes this command executor

Parameters:

context - The context in which this command was executed

Returns:

The result of the command

tabComplete

@NotNull
default @NotNull TabComplete tabComplete(CommandContext context)

Gets the tabcomplete for this command executor

Parameters:

context - The context in which this command was tab completed

Returns:

The tab completions

getPermissionString

@Nullable
@Nullable String getPermissionString()

Gets the permission for this command, registered in the plugin.yml file

Returns:

The permission, or null if it doesn't require one

hasPermission

boolean hasPermission()

Gets whether this command has a permission or not

Returns:

true if this command has a permission, false otherwise

getDescription

@Nullable
@Nullable String getDescription()

Gets the description of this command

Returns:

The description

hasDescription

boolean hasDescription()

Gets whether this command has a description or not

Returns:

true if this command has a description, false otherwise

getUsages

@NotNull
@NotNull List<String> getUsages()

Gets the usages for this command

Returns:

The usages