Class ResolvedCommandAction

java.lang.Object

dev.ua.theroer.magicutils.commands.ResolvedCommandAction

public final class ResolvedCommandAction
extends Object

Public immutable view of an executable command action.

Constructor Summary

Constructors

Constructor	Description
ResolvedCommandAction(String name, List<String> path, String description, List<String> aliases, String permission, MagicPermissionDefault permissionDefault, CommandThreading threading, List<CommandArgument> arguments)	Creates a new resolved command action.

Method Summary

Modifier and Type	Method	Description
List<String>	aliases()	Returns the aliases for this action.
List<CommandArgument>	arguments()	Returns the list of arguments for this action.
String	description()	Returns the description of the action.
String	fullPath()	Returns the full space-separated command path.
List<String>	fullPathSegments()	Returns the full path segments including the action name.
String	name()	Returns the name of the action.
List<String>	path()	Returns the command path segments leading to this action.
String	permission()	Returns the required permission node.
MagicPermissionDefault	permissionDefault()	Returns the default permission state.
CommandThreading	threading()	Returns the execution threading mode.

Methods inherited from class Object

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

Constructor Details

ResolvedCommandAction

public ResolvedCommandAction(String name,
 List<String> path,
 String description,
 List<String> aliases,
 String permission,
 MagicPermissionDefault permissionDefault,
 CommandThreading threading,
 List<CommandArgument> arguments)

Creates a new resolved command action.

Parameters:

name - action name

path - command path segments

description - action description

aliases - action aliases

permission - required permission

permissionDefault - default permission state

threading - execution threading mode

arguments - list of command arguments

Method Details

name

public String name()

Returns the name of the action.

Returns:

action name

path

public List<String> path()

Returns the command path segments leading to this action.

Returns:

path segments

description

public String description()

Returns the description of the action.

Returns:

action description

aliases

public List<String> aliases()

Returns the aliases for this action.

Returns:

list of 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

threading

public CommandThreading threading()

Returns the execution threading mode.

Returns:

threading mode

arguments

public List<CommandArgument> arguments()

Returns the list of arguments for this action.

Returns:

command arguments

fullPathSegments

public List<String> fullPathSegments()

Returns the full path segments including the action name.

Returns:

full path segments

fullPath

public String fullPath()

Returns the full space-separated command path.

Returns:

full path string