public class Argument
extends java.lang.Object
Constructor and Description |
---|
Argument(java.lang.String primaryForm,
boolean argRequired,
java.lang.String... parameterNames)
Contructor to create an argument definition.
|
Modifier and Type | Method and Description |
---|---|
Argument |
addForm(java.lang.String aliasName)
Adds a possible representation of the command line argument.
|
ArgumentHandler |
getArgumentHandler()
Returns the argument handler.
|
java.lang.String[] |
getDefaults()
Returns the defaults.
|
java.lang.String |
getDescription()
Returns a usage description of this argument.
|
java.lang.String[] |
getEnvVars()
Returns the environment variable names for each parameter.
|
java.util.List<java.lang.String> |
getForms()
Returns a list of all valid representations of this command line argument.
|
int |
getParameterCount()
Returns the number of parameters that this argument takes.
|
java.lang.String |
getParameterName(int idx)
Returns the name of the parameter position requested.
|
java.lang.String |
getPrimaryForm()
Returns the primary form of the argument.
|
boolean |
isDefinedInEnv()
Determines if the argument provisioning has been done via the environment.
|
boolean |
isRequired()
Returns whether or not this argument is required to be defined.
|
Argument |
setArgumentHandler(ArgumentHandler aHandler)
Sets the argument handler.
|
Argument |
setDefaults(java.lang.String... newDefaults)
Sets the default values when no explicit values were provided.
|
Argument |
setDescription(java.lang.String str)
Sets a usage description for this argument.
|
Argument |
setEnvVars(java.lang.String... newEnvVars)
Sets the environment variables which will be checked for values before
falling back on the default values.
|
java.lang.String |
toString()
Returns a human readable form.
|
public Argument(java.lang.String primaryForm, boolean argRequired, java.lang.String... parameterNames)
primaryForm
- the form of the argument (e.g., --foo). Should start
with a dash.argRequired
- flag indicating whether or not the argument is
required to be onthe command lineparameterNames
- names of the parameters to this argument for use in
the usage generationpublic int getParameterCount()
public java.lang.String getParameterName(int idx)
idx
- parameter indexpublic boolean isRequired()
public boolean isDefinedInEnv()
public Argument setArgumentHandler(ArgumentHandler aHandler)
aHandler
- argument handlerpublic ArgumentHandler getArgumentHandler()
public Argument addForm(java.lang.String aliasName)
aliasName
- additional form to acceptpublic java.lang.String getPrimaryForm()
public java.util.List<java.lang.String> getForms()
public Argument setDescription(java.lang.String str)
str
- usage descriptionpublic java.lang.String getDescription()
public Argument setDefaults(java.lang.String... newDefaults)
newDefaults
- default values for all argument parameterspublic java.lang.String[] getDefaults()
public Argument setEnvVars(java.lang.String... newEnvVars)
newEnvVars
- environment variable name arraypublic java.lang.String[] getEnvVars()
public java.lang.String toString()
toString
in class java.lang.Object