public class Command
extends java.lang.Object
| Constructor and Description |
|---|
Command() |
| Modifier and Type | Method and Description |
|---|---|
static boolean |
argumentIsPresent()
Returns true iff an argument is actually present on the command line.
|
static java.lang.String |
completeFileName(java.lang.String name,
java.lang.String ext)
Returns a file's name completed with its extension if the latter
is missing.
|
static void |
defineOption(java.lang.String option,
java.lang.String defaultValue)
Defines an option with a default value.
|
static void |
defineOption(java.lang.String option,
java.lang.String defaultValue,
java.lang.String help)
Defines an option with a default value and description.
|
static java.lang.String |
fileNameDir(java.lang.String name)
Returns a file's name's directory part.
|
static java.lang.String |
fileNamePrefix(java.lang.String name)
Returns a file's name without its extension nor its directory path.
|
static java.lang.String |
fileNameSuffix(java.lang.String name)
Returns a file's name extension.
|
static java.lang.String |
fullFileNamePrefix(java.lang.String name)
Returns a file's name without its extension, but including its directory path.
|
static java.lang.String |
getArgument()
Returns the value of the argument.
|
static java.lang.String[] |
getArguments()
Returns the array of values of all the arguments.
|
static java.lang.String |
getOption(java.lang.String option)
Returns the value associated with an option.
|
static java.lang.String |
getUsage() |
static void |
optionalArgument(java.lang.String arg)
Sets the default argument to the specified string.
|
static boolean |
optionIsPresent(java.lang.String option)
Returns true iff the option is actually present on the command line.
|
static boolean |
parseCommandLine(java.lang.String[] args)
Parses the command line recognizing the defined options and the
arguments, and storing their specified values as appropriate.
|
static void |
printHelp()
Prints a listing of known options, their defaults, and descriptions.
|
static void |
printUsage() |
static void |
setUsage(java.lang.String usg) |
public static final void optionalArgument(java.lang.String arg)
arg - value to use if the command argument is missingpublic static final void defineOption(java.lang.String option,
java.lang.String defaultValue)
option - the option stringdefaultValue - the option's defaultpublic static final void defineOption(java.lang.String option,
java.lang.String defaultValue,
java.lang.String help)
option - the option stringdefaultValue - the option's defaulthelp - option's descriptionpublic static final java.lang.String getOption(java.lang.String option)
option - the optionpublic static final boolean optionIsPresent(java.lang.String option)
option - the optionpublic static final java.lang.String getArgument()
public static final java.lang.String[] getArguments()
public static final boolean argumentIsPresent()
public static final java.lang.String fullFileNamePrefix(java.lang.String name)
name - the file's namepublic static final java.lang.String fileNamePrefix(java.lang.String name)
name - the file's namepublic static final java.lang.String fileNameDir(java.lang.String name)
name - the file's namepublic static final java.lang.String fileNameSuffix(java.lang.String name)
name - the file's namepublic static final java.lang.String completeFileName(java.lang.String name,
java.lang.String ext)
name - the file's nameext - the file's extensionpublic static java.lang.String getUsage()
public static void setUsage(java.lang.String usg)
public static void printUsage()
public static final void printHelp()
public static final boolean parseCommandLine(java.lang.String[] args)