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.1_1

Author:

Johnny_JayJay

Method Summary

Modifier and Type	Method	Description
String[]	getArgs()	Returns the arguments of the command.
List<String>	getArgsAsList()	Returns the command arguments not as an array, but as a List.
ICommand	getExecutor()	Returns the ICommand instance that executed this command.
String	getJoinedArgs()	Returns the arguments as a single String.
String	getJoinedArgs(int fromIndex)	Deprecated. This method was deprecated and replaced by CommandEvent.Command#joinArgs.
String	getLabel()	Returns the label of the command.
String	getRawArgs()	Gets the unmodified arguments of this Command.
String	getRawMessage()	Returns the raw content of the event message.
String	joinArgs(int fromIndex)	Joins the command arguments from a specific index on.
String	joinArgs(int fromIndex, int toIndex)	Joins the command arguments from and to a specific index.
String	joinArgs(CharSequence delimiter, int fromIndex, int toIndex)	Joins the command arguments with a specific delimiter from and to a specific index.

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 command.

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 arguments of the command.

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 ICommand instance that executed this command.

Returns:

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

getRawMessage

public String getRawMessage()

Returns the raw content of the event message.

Returns:

The raw Message that can also be retrieved with CommandEvent#getMessage#getContentRaw

getRawArgs

public String getRawArgs()

Gets the unmodified arguments of this Command.

Returns:

the raw message without the prefix and the label.

getArgsAsList

public List<String> getArgsAsList()

Returns the command arguments not as an array, but as a List.

Returns:

the arguments as an immutable List

getJoinedArgs

public String getJoinedArgs()

Returns the arguments as a single String.

Returns:

the arguments joined with a space

getJoinedArgs

@Deprecated
public String getJoinedArgs(int fromIndex)

Deprecated.

This method was deprecated and replaced by CommandEvent.Command#joinArgs.

Returns the arguments as a single String.

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.

joinArgs

public String joinArgs(int fromIndex)

Joins the command arguments from a specific index on.

Parameters:

fromIndex - a start index which may not be out of bounds.

Returns:

the arguments, joined with a space from a specific index on

Throws:

IllegalArgumentException - if a parameter does not apply to the requirements.

joinArgs

public String joinArgs(int fromIndex,
                       int toIndex)

Joins the command arguments from and to a specific index.

Parameters:

fromIndex - a start index which may not be out of bounds.

toIndex - an end index which may not be smaller than fromIndex nor out of bounds.

Returns:

the arguments, joined with a space within a specific range

Throws:

IllegalArgumentException - if a parameter does not apply to the requirements.

joinArgs

public String joinArgs(@Nonnull
                       CharSequence delimiter,
                       int fromIndex,
                       int toIndex)

Joins the command arguments with a specific delimiter from and to a specific index.

Parameters:

delimiter - the delimiter that is supposed to join the arguments.

fromIndex - a start index which may not be out of bounds.

toIndex - an end index which may not be smaller than fromIndex nor out of bounds.

Returns:

the arguments, joined with the given delimiter within a specific range

Throws:

IllegalArgumentException - if a parameter does not apply to the requirements.