Package org.apache.bookkeeper.tools.framework

Class HelpCommand<GlobalFlagsT extends CliFlags,CommandFlagsT extends CliFlags>

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

Constructor	Description
HelpCommand(Cli<CommandFlagsT> cli)

Method Summary

Modifier and Type	Method	Description
Boolean	apply(GlobalFlagsT globalFlags, String[] args)	Process the command.
String	description()	Return description name.
String	name()	Return command name.
void	usage()	Print the help information.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.bookkeeper.tools.framework.Command

category, hidden, path

Constructor Details

HelpCommand

HelpCommand(Cli<CommandFlagsT> cli)

Method Details

name

public String name()

Description copied from interface: Command

Return command name.

Specified by:

name in interface Command<GlobalFlagsT extends CliFlags>

Returns:

command name.

description

public String description()

Description copied from interface: Command

Return description name.

Specified by:

description in interface Command<GlobalFlagsT extends CliFlags>

Returns:

description name.

apply

public Boolean apply(GlobalFlagsT globalFlags,
 String[] args)
              throws Exception

Description copied from interface: Command

Process the command.

Specified by:

apply in interface Command<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: Command

Print the help information.

Specified by:

usage in interface Command<GlobalFlagsT extends CliFlags>