Class HelpCommand

java.lang.Object

pro.gravit.utils.command.Command

pro.gravit.utils.command.basic.HelpCommand

public final class HelpCommand
extends pro.gravit.utils.command.Command

Field Summary

Fields inherited from class pro.gravit.utils.command.Command

childCommands

Constructor Summary

Constructors

Constructor	Description
HelpCommand(pro.gravit.utils.command.CommandHandler handler)

Method Summary

Modifier and Type	Method	Description
String	getArgsDescription()
String	getUsageDescription()
void	invoke(String... args)
static void	printCommand(String name, pro.gravit.utils.command.Command command)
static void	printSubCommandsHelp(String name, String[] args, pro.gravit.utils.command.Command command)
static void	printSubCommandsHelp(String base, pro.gravit.utils.command.Command command)

Methods inherited from class pro.gravit.utils.command.Command

buildCandidate, complete, invokeSubcommands, parseUsername, parseUUID, verifyArgs

Methods inherited from class Object

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

Constructor Details

HelpCommand

public HelpCommand(pro.gravit.utils.command.CommandHandler handler)

Method Details

printCommand

public static void printCommand(String name,
 pro.gravit.utils.command.Command command)

printSubCommandsHelp

public static void printSubCommandsHelp(String base,
 pro.gravit.utils.command.Command command)

printSubCommandsHelp

public static void printSubCommandsHelp(String name,
 String[] args,
 pro.gravit.utils.command.Command command)
                                 throws pro.gravit.utils.command.CommandException

Throws:

pro.gravit.utils.command.CommandException

getArgsDescription

public String getArgsDescription()

Specified by:

getArgsDescription in class pro.gravit.utils.command.Command

getUsageDescription

public String getUsageDescription()

Specified by:

getUsageDescription in class pro.gravit.utils.command.Command

invoke

public void invoke(String... args)
            throws pro.gravit.utils.command.CommandException

Specified by:

invoke in class pro.gravit.utils.command.Command

Throws:

pro.gravit.utils.command.CommandException