Package net.royalur.cli

Class CLICommand

java.lang.Object

net.royalur.cli.CLICommand

Direct Known Subclasses:

CLIRoutingCommand, LutMoveStatsCommand, LutReadCommand, LutTrainCommand, StatsCountCommand

public abstract class CLICommand
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final List<CLIArgument>	args
final String	description
final String	name
final CLICommand	parent

Constructor Summary

Constructors

Constructor	Description
CLICommand(CLICommand parent, String name, String description)

Method Summary

Modifier and Type	Method	Description
void	addOptionalArg(String name, CLIArgumentType type, String... descriptionLines)
void	addRequiredArg(String name, CLIArgumentType type, String... descriptionLines)
protected void	appendCommandNoArgs(StringBuilder builder)
protected void	appendPositionalArgs(StringBuilder builder, boolean leadingSpace)
int	countKeywordArgs()
int	countPositionalArgs()
String	getCommand()
String	getCommandForHelp()
protected String	getCommandForHelp(boolean includeArgs)
String	getCommandNoArgs()
CLICommand[]	getCommandStack()
abstract CLIHandler	handle(CLI cli)
void	printHelp(PrintStream out)

Methods inherited from class java.lang.Object

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

Field Details

parent

@Nullable
public final CLICommand parent

name

public final String name

description

public final String description

args

public final List<CLIArgument> args

Constructor Details

CLICommand

public CLICommand(@Nullable
 CLICommand parent,
 String name,
 String description)

Method Details

addRequiredArg

public void addRequiredArg(String name,
 CLIArgumentType type,
 String... descriptionLines)

addOptionalArg

public void addOptionalArg(String name,
 CLIArgumentType type,
 String... descriptionLines)

countPositionalArgs

public int countPositionalArgs()

countKeywordArgs

public int countKeywordArgs()

getCommandStack

public CLICommand[] getCommandStack()

appendCommandNoArgs

protected void appendCommandNoArgs(StringBuilder builder)

appendPositionalArgs

protected void appendPositionalArgs(StringBuilder builder,
 boolean leadingSpace)

getCommandForHelp

protected String getCommandForHelp(boolean includeArgs)

getCommandForHelp

public String getCommandForHelp()

getCommandNoArgs

public String getCommandNoArgs()

getCommand

public String getCommand()

printHelp

public void printHelp(PrintStream out)

handle

@Nullable
public abstract CLIHandler handle(CLI cli)
                           throws Exception

Throws:

Exception