java.lang.Object
org.apache.bookkeeper.tools.framework.HelpCommand<GlobalFlagsT,CommandFlagsT>
- All Implemented Interfaces:
Command<GlobalFlagsT>
class HelpCommand<GlobalFlagsT extends CliFlags,CommandFlagsT extends CliFlags>
extends Object
implements Command<GlobalFlagsT>
Help command to show help information.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapply(GlobalFlagsT globalFlags, String[] args) Process the command.Return description name.name()Return command name.voidusage()Print the help information.
-
Constructor Details
-
HelpCommand
HelpCommand(Cli<CommandFlagsT> cli)
-
-
Method Details
-
name
Description copied from interface:CommandReturn command name.- Specified by:
namein interfaceCommand<GlobalFlagsT extends CliFlags>- Returns:
- command name.
-
description
Description copied from interface:CommandReturn description name.- Specified by:
descriptionin interfaceCommand<GlobalFlagsT extends CliFlags>- Returns:
- description name.
-
apply
Description copied from interface:CommandProcess the command.- Specified by:
applyin interfaceCommand<GlobalFlagsT extends CliFlags>args- command args- Returns:
- true if successfully apply the args, otherwise false
- Throws:
Exception
-
usage
public void usage()Description copied from interface:CommandPrint the help information.- Specified by:
usagein interfaceCommand<GlobalFlagsT extends CliFlags>
-