org.gudy.azureus2.ui.console.commands
Class OptionsConsoleCommand

java.lang.Object
  extended by org.gudy.azureus2.ui.console.commands.IConsoleCommand
      extended by org.gudy.azureus2.ui.console.commands.OptionsConsoleCommand
Direct Known Subclasses:
AddFind, Alias, Log, Priority

public abstract class OptionsConsoleCommand
extends IConsoleCommand

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

Author:
pauld
See Also:
Options

Nested Class Summary
 
Nested classes/interfaces inherited from class org.gudy.azureus2.ui.console.commands.IConsoleCommand
IConsoleCommand.TorrentComparator
 
Constructor Summary
OptionsConsoleCommand(String main_name)
           
OptionsConsoleCommand(String main_name, String short_name)
           
 
Method Summary
abstract  void execute(String commandName, ConsoleInput console, org.apache.commons.cli.CommandLine commandLine)
          execute using the specified command line.
 void execute(String commandName, ConsoleInput console, List arguments)
          take the args and try and create a command line object
protected  org.apache.commons.cli.Options getOptions()
           
protected  org.apache.commons.cli.CommandLineParser getParser()
           
 void printHelpExtra(PrintStream out, List args)
           
 
Methods inherited from class org.gudy.azureus2.ui.console.commands.IConsoleCommand
expandVariable, getCommandDescriptions, getCommandName, getCommandNames, getDefaultSummaryFormat, getShortCommandName, getTorrentSummary, printHelp, printHelp
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionsConsoleCommand

public OptionsConsoleCommand(String main_name)

OptionsConsoleCommand

public OptionsConsoleCommand(String main_name,
                             String short_name)
Method Detail

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

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()