Package org.harctoolbox.cmdline

Class CmdLineProgram

java.lang.Object

org.harctoolbox.cmdline.CmdLineProgram

Direct Known Subclasses:

IrpTransmogrifier

public abstract class CmdLineProgram
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.beust.jcommander.JCommander	argumentParser
protected String	command
protected final CommandBasicOptions	commandBasicOptions
protected final CommandHelp	commandHelp
protected String[]	originalArguments
protected PrintStream	out

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CmdLineProgram(PrintStream out, CommandBasicOptions commandLineArgs, String progName)
protected	CmdLineProgram(CommandBasicOptions commandLineArgs, String progName)

Method Summary

Modifier and Type	Method	Description
void	extraSetup()
final PrintStream	getOutputStream()
protected void	parseArgs(String[] args)
abstract ProgramExitStatus	processCommand()
protected ProgramExitStatus	processHelpAndDescription()
ProgramExitStatus	run(String[] args)
protected void	setupCmds(AbstractCommand... cmds)
protected void	setupLoggers()
void	usage(String command)

Methods inherited from class java.lang.Object

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

Field Details

out

protected PrintStream out

argumentParser

protected final com.beust.jcommander.JCommander argumentParser

commandHelp

protected final CommandHelp commandHelp

originalArguments

protected String[] originalArguments

commandBasicOptions

protected final CommandBasicOptions commandBasicOptions

command

protected String command

Constructor Details

CmdLineProgram

protected CmdLineProgram(PrintStream out,
 CommandBasicOptions commandLineArgs,
 String progName)

CmdLineProgram

protected CmdLineProgram(CommandBasicOptions commandLineArgs,
 String progName)

Method Details

getOutputStream

public final PrintStream getOutputStream()

usage

public void usage(String command)

run

public ProgramExitStatus run(String[] args)

setupCmds

protected void setupCmds(AbstractCommand... cmds)

parseArgs

protected void parseArgs(String[] args)
                  throws FileNotFoundException,
UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

processHelpAndDescription

protected ProgramExitStatus processHelpAndDescription()

setupLoggers

protected void setupLoggers()
                     throws UsageException,
IOException

Throws:

UsageException

IOException

extraSetup

public void extraSetup()

processCommand

public abstract ProgramExitStatus processCommand()