Class OptionParser

java.lang.Object

org.jlab.utils.options.OptionParser

public class OptionParser
extends Object

Author:

gavalian

Constructor Summary

Constructors

Constructor	Description
OptionParser()
OptionParser(String pname)

Method Summary

Modifier and Type	Method	Description
void	addOption(String key, String defaultValue)
void	addOption(String key, String defaultValue, String description)
void	addRequired(String key)
void	addRequired(String key, String desc)
boolean	containsOptions(List<String> arguments, String... options)
List<String>	getInputList()
Level	getLogLevel()
OptionValue	getOption(String option)
String	getUsageString()
static String	getVersion()
boolean	hasOption(String option)
static void	main(String[] args)
static void	overrideLogLevel(String level, String... classList)	Set the log level of a list of classes to your preferred level.
void	parse(String... args)
void	printUsage()
void	setDescription(String desc)
void	setRequiresInputList(boolean flag)
void	show()
void	syncLogLevel(Logger externalLogger)	Set the log level to be consistent with the level set by the user's -l option

Methods inherited from class Object

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

Constructor Details

OptionParser

public OptionParser()

OptionParser

public OptionParser(String pname)

Method Details

setDescription

public void setDescription(String desc)

setRequiresInputList

public void setRequiresInputList(boolean flag)

addRequired

public void addRequired(String key)

addRequired

public void addRequired(String key,
 String desc)

addOption

public void addOption(String key,
 String defaultValue)

addOption

public void addOption(String key,
 String defaultValue,
 String description)

hasOption

public boolean hasOption(String option)

getOption

public OptionValue getOption(String option)

show

public void show()

containsOptions

public boolean containsOptions(List<String> arguments,
 String... options)

getUsageString

public String getUsageString()

printUsage

public void printUsage()

parse

public void parse(String... args)

getInputList

public List<String> getInputList()

getVersion

public static String getVersion()

getLogLevel

public Level getLogLevel()

overrideLogLevel

public static void overrideLogLevel(String level,
 String... classList)

Set the log level of a list of classes to your preferred level. Use this to override the user's choice of logging level for certain classes.

Parameters:

level - the log level

classList - string names of the classes

syncLogLevel

public void syncLogLevel(Logger externalLogger)

Set the log level to be consistent with the level set by the user's -l option

Parameters:

externalLogger - an external Logger instance, typically one owned by the owner of this OptionParser instance

main

public static void main(String[] args)