Package pro.gravit.utils.command.basic

Class HelpCommand

java.lang.Object

pro.gravit.utils.command.Command

pro.gravit.utils.command.basic.HelpCommand

public final class HelpCommand
extends Command

Field Summary

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

childCommands

Constructor Summary

Constructors

Constructor	Description
HelpCommand(CommandHandler handler)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getArgsDescription()
java.lang.String	getUsageDescription()
void	invoke(java.lang.String... args)	Run current command
static void	printCommand(java.lang.String name, Command command)
static void	printSubCommandsHelp(java.lang.String name, java.lang.String[] args, Command command)
static void	printSubCommandsHelp(java.lang.String base, Command command)

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

buildCandidate, complete, invokeSubcommands, parseUsername, parseUUID, verifyArgs

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpCommand

public HelpCommand(CommandHandler handler)

Method Detail

printCommand

public static void printCommand(java.lang.String name,
                                Command command)

printSubCommandsHelp

public static void printSubCommandsHelp(java.lang.String base,
                                        Command command)

printSubCommandsHelp

public static void printSubCommandsHelp(java.lang.String name,
                                        java.lang.String[] args,
                                        Command command)
                                 throws CommandException

Throws:

CommandException

getArgsDescription

public java.lang.String getArgsDescription()

Specified by:

getArgsDescription in class Command

getUsageDescription

public java.lang.String getUsageDescription()

Specified by:

getUsageDescription in class Command

invoke

public void invoke(java.lang.String... args)
            throws CommandException

Description copied from class: Command

Run current command

Specified by:

invoke in class Command

Parameters:

args - command arguments

Throws:

CommandException