Class OptionsConsoleCommand

java.lang.Object

com.biglybt.ui.console.commands.IConsoleCommand

com.biglybt.ui.console.commands.OptionsConsoleCommand

Direct Known Subclasses:

AddFind, Alias, Priority, UserCommand.AddUserCommand, UserCommand.DeleteUserCommand, UserCommand.ModifyUserCommand

public abstract class OptionsConsoleCommand
extends IConsoleCommand

subclass of IConsoleCommand that allows the parameters to be defined using an Options object

See Also:

• Options

Nested Class Summary

Nested classes/interfaces inherited from class IConsoleCommand

IConsoleCommand.TorrentComparator

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.commons.cli.Options	options
private org.apache.commons.cli.CommandLineParser	parser

Constructor Summary

Constructors

Constructor	Description
OptionsConsoleCommand(String main_name)
OptionsConsoleCommand(String main_name, String short_name)

Method Summary

Modifier and Type	Method	Description
void	execute(String commandName, ConsoleInput console, List arguments)	take the args and try and create a command line object
abstract void	execute(String commandName, ConsoleInput console, org.apache.commons.cli.CommandLine commandLine)	execute using the specified command line.
protected org.apache.commons.cli.Options	getOptions()
protected org.apache.commons.cli.CommandLineParser	getParser()
void	printHelpExtra(PrintStream out, List args)

Methods inherited from class IConsoleCommand

expandVariable, getCommandDescriptions, getCommandName, getCommandNames, getDefaultSummaryFormat, getShortCommandName, getTorrentSummary, printHelp, printHelp

Methods inherited from class Object

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

Field Details

options

private org.apache.commons.cli.Options options

parser

private org.apache.commons.cli.CommandLineParser parser

Constructor Details

OptionsConsoleCommand

public OptionsConsoleCommand(String main_name)

OptionsConsoleCommand

public OptionsConsoleCommand(String main_name,
 String short_name)

Method Details

execute

public void execute(String commandName,
 ConsoleInput console,
 List arguments)

take the args and try and create a command line object

Specified by:

execute in class IConsoleCommand

Parameters:

commandName -

console -

arguments -

printHelpExtra

public void printHelpExtra(PrintStream out,
 List args)

Overrides:

printHelpExtra in class IConsoleCommand

execute

public abstract void execute(String commandName,
 ConsoleInput console,
 org.apache.commons.cli.CommandLine commandLine)

execute using the specified command line.

Parameters:

commandName -

console -

commandLine -

getParser

protected org.apache.commons.cli.CommandLineParser getParser()

Returns:

getOptions

protected org.apache.commons.cli.Options getOptions()