dev.jorel.commandapi.executors.ResultingCommandExecutor Interface Reference

A resulting command executor for a CommandSender. More...

Inheritance diagram for dev.jorel.commandapi.executors.ResultingCommandExecutor:

Public Member Functions
int	run (CommandSender sender, CommandArguments args) throws WrapperCommandSyntaxException
	The code to run when this command is performed. More...
default int	run (ExecutionInfo< CommandSender, BukkitCommandSender<? extends CommandSender > > info) throws WrapperCommandSyntaxException
	The code to run when this command is performed. More...
default ExecutorType	getType ()
	Returns the type of the sender of the current executor. More...
default int	executeWith (ExecutionInfo< CommandSender, WrapperType > info) throws WrapperCommandSyntaxException
	Executes the command executor with the provided command sender and the provided arguments. More...
int	run (ExecutionInfo< CommandSender, WrapperType > info) throws WrapperCommandSyntaxException
	Executes the command. More...

Detailed Description

A resulting command executor for a CommandSender.

Member Function Documentation

executeWith()

default int dev.jorel.commandapi.executors.ResultingExecutor< CommandSender, WrapperType >.executeWith ( ExecutionInfo< CommandSender, WrapperType >  info ) throws WrapperCommandSyntaxException

inherited

Executes the command executor with the provided command sender and the provided arguments.

Parameters

info	The ExecutionInfo for this command

Returns

the value returned by this command if the command succeeds, 0 if the command fails

Exceptions

WrapperCommandSyntaxException

if an error occurs during the execution of this command

getType()

default ExecutorType dev.jorel.commandapi.executors.ResultingCommandExecutor.getType

(

)

Returns the type of the sender of the current executor.

Returns

the type of the sender of the current executor

run() [1/3]

int dev.jorel.commandapi.executors.ResultingCommandExecutor.run	(	CommandSender	sender,
		CommandArguments	args
	)		throws WrapperCommandSyntaxException

The code to run when this command is performed.

Parameters

sender	The sender of this command (a player, the console etc.)
args	The arguments given to this command.

Returns

the result of this command

run() [2/3]

default int dev.jorel.commandapi.executors.ResultingCommandExecutor.run

(

ExecutionInfo< CommandSender, BukkitCommandSender<? extends CommandSender > >

info

)

throws WrapperCommandSyntaxException

The code to run when this command is performed.

Parameters

info	The ExecutionInfo for this command

Returns

the result of this command

Exceptions

WrapperCommandSyntaxException

run() [3/3]

int dev.jorel.commandapi.executors.ResultingExecutor< CommandSender, WrapperType >.run ( ExecutionInfo< CommandSender, WrapperType >  info ) throws WrapperCommandSyntaxException

inherited

Executes the command.

Parameters

info	The ExecutionInfo for this command

Returns

the value returned by this command

Exceptions

WrapperCommandSyntaxException

if an error occurs during the execution of this command