net.thevpc.common.swing.util.jcmd

Class JCmdLine

java.lang.Object

net.thevpc.common.swing.util.jcmd.JCmdLine

public class JCmdLine
extends Object

Author:

Taha BEN SALAH (taha.bensalah@gmail.com) %creationtime 13 juil. 2006 22:14:21

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRLF
static int	ERR_UNKNOWN_CMD_ARG
String	HELP1_OPTION
String	HELP2_OPTION
String	HELP3_OPTION
static String	OPTION_CMD_START
static String	OPTION_LONG_START
static String	OPTION_NEGATE
static String	OPTION_SEPARATOR
static String	OPTION_START
String	optionCmdStart
String	optionLongStart
String	optionNegate
String	optionSeparator
String	optionStart

Constructor Summary

Constructors

Constructor and Description
JCmdLine()
JCmdLine(String[] args)
JCmdLine(String defaultAguentsFile, String[] args)

Method Summary

Modifier and Type	Method and Description
void	addArguments(String[] args)
void	addExpectedOption(ExpectOption expectOption)
String	dump()
void	dump(PrintStream ps)
void	exitWithError(int errorLevel, String msg)
CmdOption	getAnyOption(String shortName, String longName)
CmdOption	getAnyOption(String shortName, String longName, boolean required)
CmdOption	getAnyOption(String shortName, String longName, boolean required, boolean caseSensitive)
String	getAnyOptionValue(String shortName, String longName)
String	getAnyOptionValue(String shortName, String longName, boolean required)
String	getAnyOptionValue(String shortName, String longName, boolean required, boolean caseSensitive)
String	getAnyOptionValue(String shortName, String longName, boolean required, boolean caseSensitive, String defaultValue)
CmdArg	getArgument(int i)
ExpectOption	getExpectedArgument(String shortOrLongName)
String	getHelp()
String	getHelpContent()
Object	getObjectFromString(Class c, String value)
CmdOption	getOption(int i)
CmdOption	getOption(String name)
CmdOption	getOption(String name, boolean required)
CmdOption	getOption(String name, boolean required, boolean caseSensitive)
String	getOptionValue(String name)
String	getOptionValue(String name, boolean required)
String	getOptionValue(String name, boolean required, boolean caseSensitive)
String	getOptionValue(String name, boolean required, boolean caseSensitive, String defaultValue)
String	getOptionValue(String label, boolean caseSensitive, String defaultValue)
Map<String,String>	getOptionValuesMap()
CmdParam	getParameter(int i)
CmdParam[]	getParameters()
Object	getReference()
String	getString(String string)
CmdOption[]	getUnknownOptions()
boolean	isAnySelectedOption(String shortName, String longName)
boolean	isAnySelectedOption(String shortName, String longName, boolean required)
boolean	isAnySelectedOption(String shortName, String longName, boolean required, boolean caseSensitive)
boolean	isAnySelectedOption(String shortName, String longName, boolean required, boolean caseSensitive, boolean defaultValue)
boolean	isCaseSensitive()
boolean	isDeclared(String label)
boolean	isDeclared(String label, boolean caseSensitive)
boolean	isExitIfError()
boolean	isExitIfHelp()
boolean	isExpectedOptions()
boolean	isHelpNeeded()
boolean	isSelectedOption(String name)
boolean	isSelectedOption(String name, boolean required)
boolean	isSelectedOption(String name, boolean required, boolean caseSensitive)
boolean	isSelectedOption(String name, boolean required, boolean caseSensitive, boolean defaultValue)
void	loadArgumentsFromFile(String fileName)
void	noExpectedOptions()
String	readFromConsole(String questionMessage, String endPattern)
void	reflectValues()
void	setArguments(String[] args)
void	setCaseSensitive(boolean caseSensitive)
void	setExitIfError(boolean exitIfError)
void	setExitIfHelp(boolean exitIfHelp)
void	setHelpContent(String helpContent)
void	setReference(Object caller)
void	showHelp()
boolean	showUnknownOptionsErrors()
void	showWinHelp(Component parent, String title)
int	size()
void	validate()
boolean	wantsHelp()

Methods inherited from class java.lang.Object

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

Field Detail

ERR_UNKNOWN_CMD_ARG

public static final int ERR_UNKNOWN_CMD_ARG

See Also:

Constant Field Values

OPTION_CMD_START

public static final String OPTION_CMD_START

See Also:

Constant Field Values

OPTION_START

public static final String OPTION_START

See Also:

Constant Field Values

OPTION_LONG_START

public static final String OPTION_LONG_START

See Also:

Constant Field Values

OPTION_NEGATE

public static final String OPTION_NEGATE

See Also:

Constant Field Values

OPTION_SEPARATOR

public static final String OPTION_SEPARATOR

See Also:

Constant Field Values

CRLF

public static final String CRLF

See Also:

Constant Field Values

HELP1_OPTION

public String HELP1_OPTION

HELP2_OPTION

public String HELP2_OPTION

HELP3_OPTION

public String HELP3_OPTION

optionStart

public String optionStart

optionLongStart

public String optionLongStart

optionCmdStart

public String optionCmdStart

optionNegate

public String optionNegate

optionSeparator

public String optionSeparator

Constructor Detail

JCmdLine

public JCmdLine()

JCmdLine

public JCmdLine(String[] args)

JCmdLine

public JCmdLine(String defaultAguentsFile,
                String[] args)

Method Detail

addExpectedOption

public void addExpectedOption(ExpectOption expectOption)

getExpectedArgument

public ExpectOption getExpectedArgument(String shortOrLongName)

validate

public void validate()

getOption

public CmdOption getOption(int i)

getParameter

public CmdParam getParameter(int i)

getArgument

public CmdArg getArgument(int i)

isAnySelectedOption

public boolean isAnySelectedOption(String shortName,
                                   String longName)

isAnySelectedOption

public boolean isAnySelectedOption(String shortName,
                                   String longName,
                                   boolean required)

isAnySelectedOption

public boolean isAnySelectedOption(String shortName,
                                   String longName,
                                   boolean required,
                                   boolean caseSensitive)

isAnySelectedOption

public boolean isAnySelectedOption(String shortName,
                                   String longName,
                                   boolean required,
                                   boolean caseSensitive,
                                   boolean defaultValue)

getAnyOptionValue

public String getAnyOptionValue(String shortName,
                                String longName)

getAnyOptionValue

public String getAnyOptionValue(String shortName,
                                String longName,
                                boolean required)

getAnyOptionValue

public String getAnyOptionValue(String shortName,
                                String longName,
                                boolean required,
                                boolean caseSensitive)

getAnyOptionValue

public String getAnyOptionValue(String shortName,
                                String longName,
                                boolean required,
                                boolean caseSensitive,
                                String defaultValue)

getAnyOption

public CmdOption getAnyOption(String shortName,
                              String longName)

getAnyOption

public CmdOption getAnyOption(String shortName,
                              String longName,
                              boolean required)

getAnyOption

public CmdOption getAnyOption(String shortName,
                              String longName,
                              boolean required,
                              boolean caseSensitive)

getOptionValue

public String getOptionValue(String name)

getOptionValue

public String getOptionValue(String name,
                             boolean required)

getOptionValue

public String getOptionValue(String name,
                             boolean required,
                             boolean caseSensitive)

getOptionValue

public String getOptionValue(String name,
                             boolean required,
                             boolean caseSensitive,
                             String defaultValue)

isSelectedOption

public boolean isSelectedOption(String name)

isSelectedOption

public boolean isSelectedOption(String name,
                                boolean required)

isSelectedOption

public boolean isSelectedOption(String name,
                                boolean required,
                                boolean caseSensitive)

isSelectedOption

public boolean isSelectedOption(String name,
                                boolean required,
                                boolean caseSensitive,
                                boolean defaultValue)

getOption

public CmdOption getOption(String name)

getOption

public CmdOption getOption(String name,
                           boolean required)

getOption

public CmdOption getOption(String name,
                           boolean required,
                           boolean caseSensitive)

getOptionValuesMap

public Map<String,String> getOptionValuesMap()

size

public int size()

getHelp

public String getHelp()

getObjectFromString

public Object getObjectFromString(Class c,
                                  String value)

getReference

public Object getReference()

getString

public String getString(String string)
                 throws IOException

Throws:

IOException

isDeclared

public boolean isDeclared(String label)

isDeclared

public boolean isDeclared(String label,
                          boolean caseSensitive)

setArguments

public void setArguments(String[] args)

loadArgumentsFromFile

public void loadArgumentsFromFile(String fileName)
                           throws IOException

Throws:

IOException

addArguments

public void addArguments(String[] args)

readFromConsole

public String readFromConsole(String questionMessage,
                              String endPattern)
                       throws IOException

Throws:

IOException

reflectValues

public void reflectValues()

getOptionValue

public String getOptionValue(String label,
                             boolean caseSensitive,
                             String defaultValue)

setReference

public void setReference(Object caller)

showHelp

public void showHelp()

showWinHelp

public void showWinHelp(Component parent,
                        String title)

wantsHelp

public boolean wantsHelp()

isExitIfHelp

public boolean isExitIfHelp()

setExitIfHelp

public void setExitIfHelp(boolean exitIfHelp)

getHelpContent

public String getHelpContent()

setHelpContent

public void setHelpContent(String helpContent)

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

getParameters

public CmdParam[] getParameters()

getUnknownOptions

public CmdOption[] getUnknownOptions()

isHelpNeeded

public boolean isHelpNeeded()

showUnknownOptionsErrors

public boolean showUnknownOptionsErrors()

dump

public void dump(PrintStream ps)
          throws IOException

Throws:

IOException

dump

public String dump()

isExitIfError

public boolean isExitIfError()

setExitIfError

public void setExitIfError(boolean exitIfError)

exitWithError

public void exitWithError(int errorLevel,
                          String msg)

isExpectedOptions

public boolean isExpectedOptions()

noExpectedOptions

public void noExpectedOptions()