org.vishia.mainCmd

Class SampleCmdLine.CmdLine

java.lang.Object

org.vishia.mainCmd.MainCmd

org.vishia.mainCmd.SampleCmdLine.CmdLine

All Implemented Interfaces:

java.io.Closeable, java.lang.Appendable, java.lang.AutoCloseable, MainCmd_ifc, MainCmdLogging_ifc, Report, LogMessage

Enclosing class:

SampleCmdLine

static class SampleCmdLine.CmdLine
extends MainCmd

The inner class CmdLine helps to evaluate the command line arguments and show help messages on command line.

Nested Class Summary

Nested classes/interfaces inherited from class org.vishia.mainCmd.MainCmd

MainCmd.Argument, MainCmd.LogMessageImplErrConsole, MainCmd.LogMessageImplFile, MainCmd.SetArgument

Field Summary

Fields

Modifier and Type	Field and Description
(package private) SampleCmdLine.Args	cmdlineArgs

Fields inherited from class org.vishia.mainCmd.MainCmd

argList, bHelpIswritten, cmdLineArgs, currdir, dateFormatMsg, errCmdline, fReport, kError_writeInfoDirectly, kInfo_writeInfoDirectly, kInfoln_writeInfoDirectly, kWarning_writeInfoDirectly, listAboutInfo, listHelpInfo, logMessageConsole, logMessageErrConsole, logMessageFile, logMessageImplReport, mError_writeInfoDirectly, mNewln_writeInfoDirectly, msgDisp, mWarning_writeInfoDirectly, nLevelDisplayToReport, nLogLevel, nReportLevelDisplay, outCmdline, sVersion

Fields inherited from interface org.vishia.mainCmd.MainCmdLogging_ifc

anytime, eventOrder, exitSuccessfull, exitUserAbort, exitWithArgumentError, exitWithErrors, exitWithFileProblems, exitWithNotes, exitWithWarnings, fineEventOrder, interested, version

Fields inherited from interface org.vishia.msgDispatch.LogMessage

dateFormat, debug, error, fineDebug, fineInfo, info, minSecondsFormat, mNeverOutputToDisplay, mReportLevel, warning

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CmdLine(java.lang.String[] argsInput, SampleCmdLine.Args cmdlineArgs) Constructor of the main class.

Method Summary

Modifier and Type	Method and Description
protected void	callWithoutArguments() Invoked from parseArguments if no argument is given.
protected boolean	checkArguments() Checks the cmdline arguments relation together.
protected boolean	testArgument(java.lang.String arg, int nArg) Tests one argument.

Methods inherited from class org.vishia.mainCmd.MainCmd

addAboutInfo, addArgument, addHelpInfo, addMsgConfig, addStandardHelpInfo, append, append, append, close, currdir, executeCmdLine, executeCmdLine, executeCmdLine, executeCmdLine, executeCmdLine, executeCmdLine, exit, flush, flushReport, getArgument, getExitErrorLevel, getLogging_ifc, getLogMessageErrorConsole, getLogMessageOutputConsole, getLogMessageOutputFile, getReportFileName, getReportLevel, getReportLevelFromIdent, isOnline, openReportfile, parseArguments, parseArguments, replaceEnv, report, report, reportln, reportln, sendMsg, sendMsgTime, sendMsgTimeToAppendableDst, sendMsgVaList, setcurrdir, setExitErrorLevel, setLogMessageDestination, setOutputChannels, setReportLevel, setReportLevelToIdent, startCmdLine, startCmdLine, switchToWindowOrStartCmdline, writeAboutInfo, writeDirectly, writeError, writeError, writeError, writeErrorAdd, writeErrorDirectly, writef, writeHelpInfo, writeInfo, writeInfo, writeInfoAdd, writeInfoln, writeStackTrace, writeWarning, writeWarning, writeWarningAdd, XXXassertion

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vishia.msgDispatch.LogMessage

msgSec, timeCurr, timeMsg

Field Detail

cmdlineArgs

final SampleCmdLine.Args cmdlineArgs

Constructor Detail

CmdLine

private CmdLine(java.lang.String[] argsInput,
                SampleCmdLine.Args cmdlineArgs)

Constructor of the main class. The command line arguments are parsed here. After them the execute class is created as composition of SampleCmdLine.

Method Detail

testArgument

protected boolean testArgument(java.lang.String arg,
                               int nArg)

Tests one argument. This method is invoked from parseArgument. It is abstract in the superclass MainCmd and must be overwritten from the user. :TODO: user, test and evaluate the content of the argument string or test the number of the argument and evaluate the content in dependence of the number.

Overrides:

testArgument in class MainCmd

Parameters:

argc - String of the actual parsed argument from cmd line

nArg - number of the argument in order of the command line, the first argument is number 1.

Returns:

true is okay, false if the argument doesn't match. The parseArgument method in MainCmd throws an exception, the application should be aborted.

callWithoutArguments

protected void callWithoutArguments()
                             throws java.text.ParseException

Invoked from parseArguments if no argument is given. In the default implementation a help info is written and the application is terminated. The user should overwrite this method if the call without command line arguments is meanfull.

Overrides:

callWithoutArguments in class MainCmd

Throws:

java.text.ParseException

checkArguments

protected boolean checkArguments()

Checks the cmdline arguments relation together. If there is an inconsistents, a message should be written. It may be also a warning. :TODO: the user only should determine the specific checks, this is a sample.

Specified by:

checkArguments in class MainCmd

Returns:

true if successfull, false if failed.