Class ResolvedCommandSchema

java.lang.Object

dev.ua.theroer.magicutils.commands.ResolvedCommandSchema

public final class ResolvedCommandSchema
extends Object

Public immutable view of a registered command and its resolved actions.

Constructor Summary

Constructors

Constructor	Description
ResolvedCommandSchema(String name, String description, List<String> aliases, String permission, MagicPermissionDefault permissionDefault, ResolvedCommandAction directAction, ResolvedSubCommandNode subCommands)	Creates a new resolved command schema.

Method Summary

Modifier and Type	Method	Description
List<String>	aliases()	Returns the command aliases.
String	description()	Returns the command description.
ResolvedCommandAction	directAction()	Returns the direct action for the root command.
String	name()	Returns the command name.
String	permission()	Returns the required permission node.
MagicPermissionDefault	permissionDefault()	Returns the default permission state.
List<String>	rootLabels()	Returns all root labels (name + aliases) for this command.
ResolvedSubCommandNode	subCommands()	Returns the subcommand tree.

Methods inherited from class Object

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

Constructor Details

ResolvedCommandSchema

public ResolvedCommandSchema(String name,
 String description,
 List<String> aliases,
 String permission,
 MagicPermissionDefault permissionDefault,
 ResolvedCommandAction directAction,
 ResolvedSubCommandNode subCommands)

Creates a new resolved command schema.

Parameters:

name - command name

description - command description

aliases - command aliases

permission - required permission

permissionDefault - default permission state

directAction - action for the root command (can be null)

subCommands - subcommand tree

Method Details

name

public String name()

Returns the command name.

Returns:

command name

description

public String description()

Returns the command description.

Returns:

command description

aliases

public List<String> aliases()

Returns the command aliases.

Returns:

command aliases

permission

public String permission()

Returns the required permission node.

Returns:

permission node

permissionDefault

public MagicPermissionDefault permissionDefault()

Returns the default permission state.

Returns:

default permission

directAction

public ResolvedCommandAction directAction()

Returns the direct action for the root command.

Returns:

direct action or null

subCommands

public ResolvedSubCommandNode subCommands()

Returns the subcommand tree.

Returns:

subcommands

rootLabels

public List<String> rootLabels()

Returns all root labels (name + aliases) for this command.

Returns:

root labels