Package com.github.johnnyjayjay.discord.commandapi

Class CommandEvent.Command

java.lang.Object

com.github.johnnyjayjay.discord.commandapi.CommandEvent.Command

Enclosing class:

CommandEvent

public static class CommandEvent.Command
extends Object

Describes an executed Command.

Is used to parse a message which seems to be a command.

Version:

3.0

Author:

Johnny_JayJay

Method Summary

Modifier and Type	Method	Description
String[]	getArgs()
List<String>	getArgsAsList()
ICommand	getExecutor()
String	getJoinedArgs()
String	getJoinedArgs(int fromIndex)
String	getLabel()

Methods inherited from class java.lang.Object

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

Method Detail

getLabel

public String getLabel()

Returns:

The label of the called command, e.g. "foo" if someone calls the command "!foo" (if the prefix is "!")

getArgs

public String[] getArgs()

Returns:

The command arguments. In most cases, this is not of importance, because you get these already explicitly in the onCommand-method of ICommand.

getExecutor

public ICommand getExecutor()

Returns:

The object that calls the onCommand-method. Might be useful in some special cases.

getArgsAsList

public List<String> getArgsAsList()

Returns:

the arguments as an immutable List

getJoinedArgs

public String getJoinedArgs()

Returns:

the arguments joined with a space

getJoinedArgs

public String getJoinedArgs(int fromIndex)

Parameters:

fromIndex - from which argument index the Strings will be joined.

Returns:

the arguments joined with a space

Throws:

IllegalArgumentException - if the given index is invalid (higher than the argument length or lower than 0.