Package org.apache.bookkeeper.tools.framework

Class CliSpec<CliFlagsT extends CliFlags>

java.lang.Object

org.apache.bookkeeper.tools.framework.CliSpec<CliFlagsT>

public class CliSpec<CliFlagsT extends CliFlags>
extends Object

A spec to build CLI.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CliSpec.Builder<CliFlagsT extends CliFlags>	Builder to build a cli spec.

Method Summary

Modifier and Type	Method	Description
String	argumentsUsage()
protected boolean	canEqual(Object other)
String	category()
Set<Command>	commands()
PrintStream	console()
String	description()
boolean	equals(Object o)
CliFlagsT	flags()
int	hashCode()
boolean	isCommandGroup()
String	name()
static <T extends CliFlags> CliSpec.Builder<T>	newBuilder()	Create a new builder to build the cli spec.
static <T extends CliFlags> CliSpec.Builder<T>	newBuilder(CliSpec<T> spec)	Create a new builder to build the cli spec from an existing spec.
String	parent()
Function<CliFlagsT,Boolean>	runFunc()
String	tailer()
String	toString()
String	usage()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public static <T extends CliFlags>
CliSpec.Builder<T> newBuilder()

Create a new builder to build the cli spec.

Returns:

a new builder to build the cli spec.

newBuilder

public static <T extends CliFlags>
CliSpec.Builder<T> newBuilder(CliSpec<T> spec)

Create a new builder to build the cli spec from an existing spec.

Parameters:

spec - cli spec

Returns:

a new builder to build the cli spec from an existing spec.

category

public String category()

name

public String name()

parent

public String parent()

usage

public String usage()

argumentsUsage

public String argumentsUsage()

flags

public CliFlagsT flags()

description

public String description()

commands

public Set<Command> commands()

tailer

public String tailer()

runFunc

public Function<CliFlagsT,Boolean> runFunc()

console

public PrintStream console()

isCommandGroup

public boolean isCommandGroup()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object