alma::acs::logging::dialogs::main::CommandLineParser Class Reference
Public Member Functions | |
| CommandLineParser (String[] args) throws Exception | |
| boolean | getHelp () |
| boolean | isUnlimited () |
| boolean | isDoNotConnect () |
| String | getFilterFileName () |
| String | getEngineFilterFileName () |
| LogTypeHelper | getDiscardLevel () |
| String | getFileToLoad () |
| AudienceInfo | getAudience () |
Static Public Member Functions | |
| static void | printUsage (String errorMsg) |
Private Member Functions | |
| void | parse (String[] args) throws Exception |
| void | dumpOptions () |
Private Attributes | |
| boolean | help = false |
| boolean | unlimited = false |
| boolean | doNotConnect = false |
| String | filterFileName = null |
| String | engineFilterFileName = null |
| LogTypeHelper | discardLevel = LoggingClient.DEFAULT_DISCARDLEVEL |
| String | fileToLoad = null |
| AudienceInfo | audience = null |
Detailed Description
A class to parse the command line.
- Since:
- ACS 8.1.0
Constructor & Destructor Documentation
| alma::acs::logging::dialogs::main::CommandLineParser::CommandLineParser | ( | String[] | args | ) | throws Exception [inline] |
Constructor.
- Parameters:
-
args The command line parameters
- Exceptions:
-
Exception In case of error parsing the command line
References dumpOptions(), and parse().
Member Function Documentation
| void alma::acs::logging::dialogs::main::CommandLineParser::dumpOptions | ( | ) | [inline, private] |
Print a short resumen of the parameters read from the command line
References audience, discardLevel, doNotConnect, engineFilterFileName, fileToLoad, filterFileName, and unlimited.
Referenced by CommandLineParser().
| AudienceInfo alma::acs::logging::dialogs::main::CommandLineParser::getAudience | ( | ) | [inline] |
| LogTypeHelper alma::acs::logging::dialogs::main::CommandLineParser::getDiscardLevel | ( | ) | [inline] |
| String alma::acs::logging::dialogs::main::CommandLineParser::getEngineFilterFileName | ( | ) | [inline] |
Getter
References engineFilterFileName.
Referenced by alma::acs::logging::dialogs::main::LogFrame::main().
| String alma::acs::logging::dialogs::main::CommandLineParser::getFileToLoad | ( | ) | [inline] |
| String alma::acs::logging::dialogs::main::CommandLineParser::getFilterFileName | ( | ) | [inline] |
Getter
References filterFileName.
Referenced by alma::acs::logging::dialogs::main::LogFrame::main().
| boolean alma::acs::logging::dialogs::main::CommandLineParser::getHelp | ( | ) | [inline] |
| boolean alma::acs::logging::dialogs::main::CommandLineParser::isDoNotConnect | ( | ) | [inline] |
| boolean alma::acs::logging::dialogs::main::CommandLineParser::isUnlimited | ( | ) | [inline] |
| void alma::acs::logging::dialogs::main::CommandLineParser::parse | ( | String[] | args | ) | throws Exception [inline, private] |
Parse the command line.
- Exceptions:
-
Exception In case of error parsing the command line
References audience, discardLevel, doNotConnect, engineFilterFileName, fileToLoad, filterFileName, alma::acs::util::CmdLineArgs::getValues(), help, alma::acs::util::CmdLineArgs::isSpecified(), alma::acs::util::CmdLineArgs::parseArgs(), alma::acs::util::CmdLineArgs::registerOption(), and unlimited.
Referenced by CommandLineParser().
| static void alma::acs::logging::dialogs::main::CommandLineParser::printUsage | ( | String | errorMsg | ) | [inline, static] |
Print the standard usage message if the parameters in the command line are wrong.
- Parameters:
-
errorMsg An optional error message to print
Member Data Documentation
AudienceInfo alma::acs::logging::dialogs::main::CommandLineParser::audience = null [private] |
The audience to set at startup
it is null if there is no audience specified in the command line.
Referenced by dumpOptions(), getAudience(), and parse().
LogTypeHelper alma::acs::logging::dialogs::main::CommandLineParser::discardLevel = LoggingClient.DEFAULT_DISCARDLEVEL [private] |
The initial discard level
If it not set in the command line, the logging client starts with the default discard level.
Referenced by dumpOptions(), getDiscardLevel(), and parse().
boolean alma::acs::logging::dialogs::main::CommandLineParser::doNotConnect = false [private] |
true if the user do not want to connect jlog to an ACS session at startup
Referenced by dumpOptions(), isDoNotConnect(), and parse().
String alma::acs::logging::dialogs::main::CommandLineParser::engineFilterFileName = null [private] |
The name of the engine filter file to load.
it is null if there is no engine filter file name specified in the command line.
Referenced by dumpOptions(), getEngineFilterFileName(), and parse().
String alma::acs::logging::dialogs::main::CommandLineParser::fileToLoad = null [private] |
The file of logs to load at startup
it is null if there is no file name specified in the command line.
Referenced by dumpOptions(), getFileToLoad(), and parse().
String alma::acs::logging::dialogs::main::CommandLineParser::filterFileName = null [private] |
The name of the filter file to load.
it is null if there is no filter file name specified in the command line.
Referenced by dumpOptions(), getFilterFileName(), and parse().
boolean alma::acs::logging::dialogs::main::CommandLineParser::help = false [private] |
boolean alma::acs::logging::dialogs::main::CommandLineParser::unlimited = false [private] |
true if the user wants to run jlog with no limits in the number of logs in the table
Referenced by dumpOptions(), isUnlimited(), and parse().
The documentation for this class was generated from the following file:
