Class CommandLineParser.CommandLineOption

java.lang.Object

org.jlab.utils.system.CommandLineParser.CommandLineOption

Enclosing class:

CommandLineParser

public static class CommandLineParser.CommandLineOption
extends Object

This class holds all parameters required, optional and flags for given command in the command line;

Author:

gavalian

Constructor Summary

Constructors

Constructor	Description
CommandLineOption()
CommandLineOption(String cmd)

Method Summary

Modifier and Type	Method	Description
void	addCommand(String command, String explanation)
void	addFlag(String name, String description)
void	addOptionalParameter(String par, String dvalue, String description)
void	addRequiredParameter(String par, String description)
boolean	containsRequired()
void	explainMissing()
double	getAsDouble(String opt)
double[]	getAsDoubleList(String opt)
int	getAsInt(String opt)
int[]	getAsIntList(String opt)
String	getAsString(String opt)
String[]	getAsStringList(String opt)
String	getCommand()
List<String>	getInputList()
String	getOption(String opt)
boolean	hasOption(String opt)
void	parse(String[] args, int startIndex)
void	printCommands()
void	printUsage(String programName)
void	setCommand(String cmd)
void	setListDeliminator(String delim)
void	show()

Methods inherited from class java.lang.Object

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

Constructor Details

CommandLineOption

public CommandLineOption()

CommandLineOption

public CommandLineOption(String cmd)

Method Details

getCommand

public String getCommand()

setCommand

public void setCommand(String cmd)

addCommand

public void addCommand(String command,
 String explanation)

printCommands

public void printCommands()

setListDeliminator

public void setListDeliminator(String delim)

addRequiredParameter

public void addRequiredParameter(String par,
 String description)

addOptionalParameter

public void addOptionalParameter(String par,
 String dvalue,
 String description)

addFlag

public void addFlag(String name,
 String description)

parse

public void parse(String[] args,
 int startIndex)

getOption

public String getOption(String opt)

printUsage

public void printUsage(String programName)

show

public void show()

explainMissing

public void explainMissing()

containsRequired

public boolean containsRequired()

getAsInt

public int getAsInt(String opt)

getAsStringList

public String[] getAsStringList(String opt)

getAsIntList

public int[] getAsIntList(String opt)

getAsDoubleList

public double[] getAsDoubleList(String opt)

getAsDouble

public double getAsDouble(String opt)

getAsString

public String getAsString(String opt)

getInputList

public List<String> getInputList()

hasOption

public boolean hasOption(String opt)