com.datasiqn.commandcore

Class CommandCore

java.lang.Object

com.datasiqn.commandcore.CommandCore

public class CommandCore
extends Object

Main class of CommandCore

Method Summary

Modifier and Type	Method and Description
static @NotNull CommandContext	createContext(CommandSource source, Command command, String label, Arguments arguments) Creates a new CommandContext
static @NotNull CommandSource	createSource(org.bukkit.command.CommandSender sender) Creates a new CommandSource
CommandManager	getCommandManager() Gets the command manager
static CommandCore	getInstance() Gets this instance of CommandCore
InitOptions	getOptions() Gets the options used to initialize CommandCore
@NotNull List<String>	getUsagesFor(String commandName, int spaces) Generates a formatted string for each usage of a command
static @NotNull CommandCore	init(org.bukkit.plugin.java.JavaPlugin plugin, InitOptions options) Initializes CommandCore so that it can be accessed using getInstance()
static @NotNull CommandCore	init(org.bukkit.plugin.java.JavaPlugin plugin, String rootCommand) Initializes CommandCore so that it can be accessed using getInstance()
void	sendCommandHelp(@NotNull org.bukkit.command.CommandSender sender, @NotNull String commandName) Sends command usage to sender
void	sendHelpMenu(@NotNull org.bukkit.command.CommandSender sender) Sends the help menu to sender

Methods inherited from class java.lang.Object

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

Method Detail

getCommandManager

public CommandManager getCommandManager()

Gets the command manager

Returns:

The command manager

getOptions

public InitOptions getOptions()

Gets the options used to initialize CommandCore

Returns:

The options used to initialize CommandCore

sendCommandHelp

public void sendCommandHelp(@NotNull
                            @NotNull org.bukkit.command.CommandSender sender,
                            @NotNull
                            @NotNull String commandName)

Sends command usage to sender

Parameters:

sender - The sender

commandName - The name of the command

Throws:

IllegalArgumentException - If commandName is not the name of a command

sendHelpMenu

public void sendHelpMenu(@NotNull
                         @NotNull org.bukkit.command.CommandSender sender)

Sends the help menu to sender

Parameters:

sender - The sender

getUsagesFor

@NotNull
public @NotNull List<String> getUsagesFor(String commandName,
                                                    int spaces)

Generates a formatted string for each usage of a command

Parameters:

commandName - The name of the command

spaces - The # of spaces to add before each usage string

Returns:

A list of formatted strings representing all usages for the command

Throws:

IllegalArgumentException - If commandName is not the name of a command

getInstance

public static CommandCore getInstance()

Gets this instance of CommandCore

Returns:

This instance

Throws:

IllegalStateException - If CommandCore hasn't been initialized yet with init

init

@NotNull
public static @NotNull CommandCore init(org.bukkit.plugin.java.JavaPlugin plugin,
                                                  String rootCommand)

Initializes CommandCore so that it can be accessed using getInstance()

Parameters:

plugin - Your plugin instance

rootCommand - The name of your root command

Returns:

The instance

Throws:

IllegalStateException - If it has already been initialized

init

@NotNull
public static @NotNull CommandCore init(org.bukkit.plugin.java.JavaPlugin plugin,
                                                  InitOptions options)

Initializes CommandCore so that it can be accessed using getInstance()

Parameters:

plugin - Your plugin instance

options - The initialization options

Returns:

The instance

Throws:

IllegalStateException - If it has already been initialized

createContext

@Contract(value="_, _, _, _ -> new",
          pure=true)
 @NotNull
public static @NotNull CommandContext createContext(CommandSource source,
                                                                                                                           Command command,
                                                                                                                           String label,
                                                                                                                           Arguments arguments)

Creates a new CommandContext

Parameters:

source - The sender that executed the command

command - The command being executed

label - The exact string used to execute the command. This can either be the name of the command or one of its aliases

arguments - The command arguments

Returns:

The newly created CommandContext

createSource

@Contract(value="_ -> new",
          pure=true)
 @NotNull
public static @NotNull CommandSource createSource(org.bukkit.command.CommandSender sender)

Creates a new CommandSource

Parameters:

sender - The source of the command

Returns:

The newly created CommandSource