org.vishia.cmd

Class Filecmd.Cmdline

java.lang.Object

org.vishia.mainCmd.MainCmd

org.vishia.cmd.Filecmd.Cmdline

All Implemented Interfaces:

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

Enclosing class:

Filecmd

private static class Filecmd.Cmdline
extends MainCmd

Nested Class Summary

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

MainCmd.Argument, MainCmd.SetArgument

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Filecmd.Cargs	cargs

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, 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

Constructor and Description
Cmdline(Filecmd.Cargs cargs)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkArguments() Checks the arguments after parsing from command line, test of consistence.
protected boolean	testArgument(java.lang.String argc, int nArg) Tests one argument, called from parseArguments() on every argument excluding standard arguments -r and -rlevel.

Methods inherited from class org.vishia.mainCmd.MainCmd

addAboutInfo, addArgument, addHelpInfo, addMsgConfig, addStandardHelpInfo, append, append, append, callWithoutArguments, 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, 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

cargs

final Filecmd.Cargs cargs

Constructor Detail

Cmdline

Cmdline(Filecmd.Cargs cargs)

Method Detail

checkArguments

protected boolean checkArguments()

Description copied from class: MainCmd

Checks the arguments after parsing from command line, test of consistence. This method must overwrite from the user, may be with a return true. The method is ocalled at last inside parseArguments(). If this method returns false, parseArguments throws an exception in the same manner if on argument errors.

Specified by:

checkArguments in class MainCmd

Returns:

true if all is ok. If false,

testArgument

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

Description copied from class: MainCmd

Tests one argument, called from parseArguments() on every argument excluding standard arguments -r and -rlevel. The user can overwrite this method to test the application-specific parameters. This non-overridden method uses the #setArgumentList(Argument[])

Overrides:

testArgument in class MainCmd

Parameters:

argc - The argument to test

nArg - number of argument, the first argument is numbered with 1.

Returns:

false, if the argument doesn't match, true if ok. if the method returns false, an exception in parseArgument is thrown to abort the argument test or to abort the program. @see parseArgument().