Class CommandSpec<S>

java.lang.Object

dev.ua.theroer.magicutils.commands.CommandSpec<S>

Type Parameters:

S - sender type

public final class CommandSpec<S>
extends Object

Compatibility command specification used by the legacy builder path.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CommandSpec.Builder<S>	Builder for compatibility command specifications.

Method Summary

Modifier and Type	Method	Description
List<String>	aliases()	Returns configured aliases.
List<CommandArgument>	arguments()	Returns the argument definitions.
static <S> CommandSpec.Builder<S>	builder(String name)	Creates a compatibility builder for a command name.
String	description()	Returns the command description.
CommandExecutor<S>	executor()	Returns the execution handler.
String	name()	Returns the primary command name.
String	permission()	Returns the explicit permission node.
MagicPermissionDefault	permissionDefault()	Returns the default permission value.
List<SubCommandSpec<S>>	subCommands()	Returns subcommand specs.
CommandThreading	threading()	Returns the threading policy for execution.

Methods inherited from class Object

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

Method Details

name

public String name()

Returns the primary command name.

Returns:

command name

description

public String description()

Returns the command description.

Returns:

description text

aliases

public List<String> aliases()

Returns configured aliases.

Returns:

immutable alias list

permission

public String permission()

Returns the explicit permission node.

Returns:

permission string or empty when unset

permissionDefault

public MagicPermissionDefault permissionDefault()

Returns the default permission value.

Returns:

default permission enum

threading

public CommandThreading threading()

Returns the threading policy for execution.

Returns:

threading policy

arguments

public List<CommandArgument> arguments()

Returns the argument definitions.

Returns:

immutable argument list

executor

public CommandExecutor<S> executor()

Returns the execution handler.

Returns:

command executor

subCommands

public List<SubCommandSpec<S>> subCommands()

Returns subcommand specs.

Returns:

immutable subcommand list

builder

public static <S> CommandSpec.Builder<S> builder(String name)

Creates a compatibility builder for a command name.

Type Parameters:

S - sender type

Parameters:

name - command name

Returns:

new builder instance