Package com.github.cyberryan1.cybercore.spigot.command.settings

Class BaseCommand

java.lang.Object

com.github.cyberryan1.cybercore.spigot.command.settings.CommandSettings

com.github.cyberryan1.cybercore.spigot.command.settings.BaseCommand

Direct Known Subclasses:

CyberCommand, CyberSubCommand, CyberSuperCommand

public class BaseCommand
extends CommandSettings

The base structure of all other command classes. Used to validate argument types, send messages, etc.

Constructor Summary

Constructors

Constructor	Description
BaseCommand(String name, String usage)
BaseCommand(String name, String permission, String usage)
BaseCommand(String name, String permission, String permissionMsg, String usage)

Method Summary

Modifier and Type	Method	Description
final List<Integer>	getArgIndexes(ArgType type)
final ArgType	getArgType(int index)
final Map<Integer,ArgType>	getArgTypes()
final int	getMinArgLength()
final Map<Integer,List<String>>	getStringArgOptions()
final List<String>	getStringArgOptions(int index)
final boolean	isSendingValidationMsg()
final boolean	isValidatingArgs()
void	sendInvalidDoubleArg(org.bukkit.command.CommandSender sender, String arg)	Sends that the argument provided isn't a double
void	sendInvalidIntegerArg(org.bukkit.command.CommandSender sender, String arg)	Sends that the argument provided isn't an integer
void	sendInvalidPlayerArg(org.bukkit.command.CommandSender sender, String name)	Sends that the name provided isn't any player's name
void	sendPermissionMsg(org.bukkit.command.CommandSender sender)	Sends the permission message to the sender
void	sendPermMsg(org.bukkit.command.CommandSender sender)	Sends the permission message to the sender
void	sendUsage(org.bukkit.command.CommandSender sender)	Sends the usage message to the sender
final void	setArgType(int index, ArgType type)
final void	setMinArgLength(int length)
final void	setSendValidationMsg(boolean send)
final void	setStringArgOptions(int index, List<String> options)	Important Notes: The index must be set to ArgType.STRING via the setArgType(int, ArgType) method, otherwise nothing will happen If the argument provided is invalid when checking via the validateArgument(CommandSender, String, int)) method and the isSendingValidationMsg() is true, then the usage of the command will be sent
final void	setValidateArgs(boolean validate)
final boolean	validateArgument(org.bukkit.command.CommandSender sender, String arg, int index)	Validates that the argument provided is of the correct type

Methods inherited from class com.github.cyberryan1.cybercore.spigot.command.settings.CommandSettings

demandConsole, demandPermission, demandPlayer, getInvalidDoubleMsg, getInvalidIntegerMsg, getInvalidPlayerMsg, getName, getPermission, getPermissionMsg, getUsage, isDemandConsole, isDemandPermission, isDemandPlayer, isTabCompleteEnabled, permissionsAllowed, permsAllowed, runAsync, setDemandConsole, setDemandPermission, setDemandPlayer, setInvalidDoubleMsg, setInvalidIntegerMsg, setInvalidPlayerMsg, setRunAsync, setTabCompleteEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

BaseCommand

public BaseCommand(String name,
 String permission,
 String permissionMsg,
 String usage)

BaseCommand

public BaseCommand(String name,
 String permission,
 String usage)

BaseCommand

public BaseCommand(String name,
 String usage)

Method Details

validateArgument

public final boolean validateArgument(org.bukkit.command.CommandSender sender,
 String arg,
 int index)

Validates that the argument provided is of the correct type

Parameters:

sender - The command sender

arg - The argument

index - The index of the argument

Returns:

True if the argument is valid or if the argument is not of a type, false otherwise

sendPermissionMsg

public void sendPermissionMsg(org.bukkit.command.CommandSender sender)

Sends the permission message to the sender

Parameters:

sender - the sender of the command

sendPermMsg

public void sendPermMsg(org.bukkit.command.CommandSender sender)

Sends the permission message to the sender

Parameters:

sender - the sender of the command

sendUsage

public void sendUsage(org.bukkit.command.CommandSender sender)

Sends the usage message to the sender

Parameters:

sender - the sender of the command

sendInvalidPlayerArg

public void sendInvalidPlayerArg(org.bukkit.command.CommandSender sender,
 String name)

Sends that the name provided isn't any player's name

Parameters:

sender - The person to send this message to

name - The attempted username

sendInvalidIntegerArg

public void sendInvalidIntegerArg(org.bukkit.command.CommandSender sender,
 String arg)

Sends that the argument provided isn't an integer

Parameters:

sender - The person to send this message to

arg - The attempted argument

sendInvalidDoubleArg

public void sendInvalidDoubleArg(org.bukkit.command.CommandSender sender,
 String arg)

Sends that the argument provided isn't a double

Parameters:

sender - The person to send this message to

arg - The attempted argument

getArgTypes

public final Map<Integer,ArgType> getArgTypes()

Returns:

The Map of arg index to ArgType

getArgType

public final ArgType getArgType(int index)

Parameters:

index - The index of the argument to get

Returns:

The ArgType of the argument at the given index

getArgIndexes

public final List<Integer> getArgIndexes(ArgType type)

Parameters:

type - The ArgType to search for

Returns:

A List of all the indexes of the given ArgType

getStringArgOptions

public final Map<Integer,List<String>> getStringArgOptions()

Returns:

The Map of arg indexes that have been set as ArgType.STRING to the list of options for that argument

getStringArgOptions

public final List<String> getStringArgOptions(int index)

Parameters:

index - The index of the argument to get

Returns:

The List of strings that are valid for the argument at the given index

getMinArgLength

public final int getMinArgLength()

Returns:

The minimum length of the arguments

isValidatingArgs

public final boolean isValidatingArgs()

Returns:

True if the arguments are validated, false otherwise

isSendingValidationMsg

public final boolean isSendingValidationMsg()

Returns:

True if the sender is sent a message when the arguments are invalid, false otherwise

setArgType

public final void setArgType(int index,
 ArgType type)

Parameters:

index - The index of the argument to set

type - The ArgType to set the argument to

setStringArgOptions

public final void setStringArgOptions(int index,
 List<String> options)

Important Notes:

• The index must be set to ArgType.STRING via the setArgType(int, ArgType) method, otherwise nothing will happen
• If the argument provided is invalid when checking via the validateArgument(CommandSender, String, int)) method and the isSendingValidationMsg() is true, then the usage of the command will be sent

Parameters:

index - The index of the argument to set

options - The List of strings that are valid for that argument

setMinArgLength

public final void setMinArgLength(int length)

Parameters:

length - The minimum length of the arguments

setValidateArgs

public final void setValidateArgs(boolean validate)

Parameters:

validate - True if the arguments are validated, false otherwise

setSendValidationMsg

public final void setSendValidationMsg(boolean send)

Parameters:

send - True if the sender is sent a message when the arguments are invalid, false otherwise