Package org.apache.bookkeeper.tools.framework

Class CliCommand<GlobalFlagsT extends CliFlags,CommandFlagsT extends CliFlags>

java.lang.Object

org.apache.bookkeeper.tools.framework.CliCommand<GlobalFlagsT,CommandFlagsT>

All Implemented Interfaces:

Command<GlobalFlagsT>

Direct Known Subclasses:

BKCommand, CliCommandGroup

public class CliCommand<GlobalFlagsT extends CliFlags,CommandFlagsT extends CliFlags>
extends Object
implements Command<GlobalFlagsT>

A command that runs a CLI spec. it is typically used for nested sub commands.

Field Summary

Fields

Modifier and Type	Field	Description
protected CliSpec<CommandFlagsT>	spec

Constructor Summary

Constructors

Constructor	Description
CliCommand(CliSpec<CommandFlagsT> spec)

Method Summary

Modifier and Type	Method	Description
Boolean	apply(GlobalFlagsT globalFlags, String[] args)	Process the command.
String	category()	Return category of this command belongs to.
String	description()	Return description name.
String	getUsage()
String	name()	Return command name.
String	path()	Return command path in a cli path.
void	setParent(String parent)
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

hidden

Field Details

spec

protected CliSpec<CommandFlagsT extends CliFlags> spec

Constructor Details

CliCommand

public CliCommand(CliSpec<CommandFlagsT> spec)

Method Details

setParent

public void setParent(String parent)

category

public String category()

Description copied from interface: Command

Return category of this command belongs to.

Specified by:

category in interface Command<GlobalFlagsT extends CliFlags>

Returns:

category name

name

public String name()

Description copied from interface: Command

Return command name.

Specified by:

name in interface Command<GlobalFlagsT extends CliFlags>

Returns:

command name.

path

public String path()

Description copied from interface: Command

Return command path in a cli path.

This is used for printing usage information.

Specified by:

path in interface Command<GlobalFlagsT extends CliFlags>

Returns:

command path

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)

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

usage

public void usage()

Description copied from interface: Command

Print the help information.

Specified by:

usage in interface Command<GlobalFlagsT extends CliFlags>

getUsage

public String getUsage()