net.dpml.cli
Interface Argument
- Option
- ArgumentImpl, SourceDestArgument
An Option that can process values passed on the command line in the form
"--file README".
appendUsage , canProcess , canProcess , defaults , findOption , getDescription , getId , getPreferredName , getPrefixes , getTriggers , helpLines , isRequired , process , validate |
defaultValues
public void defaultValues(WriteableCommandLine commandLine,
Option option)
Adds defaults to a CommandLine.
commandLine
- the CommandLine object to store defaults in.option
- the Option to store the defaults against.
getInitialSeparator
public char getInitialSeparator()
Returns the initial separator character or
'\0' if no character has been set.
- char the initial separator character
getMaximum
public int getMaximum()
Retrieves the maximum number of values acceptable for a valid Argument
- the maximum number of values
getMinimum
public int getMinimum()
Retrieves the minimum number of values required for a valid Argument
- the minimum number of values
isRequired
public boolean isRequired()
Indicates whether argument values must be present for the CommandLine to
be valid.
- isRequired in interface Option
- true iff the CommandLine will be invalid without at least one
value
processValues
public void processValues(WriteableCommandLine commandLine,
ListIterator args,
Option option)
throws OptionException
Processes the "README" style element of the argument.
Values identified should be added to the CommandLine object in
association with this Argument.
commandLine
- The CommandLine object to store results in.args
- The arguments to process.option
- The option to register value against.
validate
public void validate(WriteableCommandLine commandLine,
Option option)
throws OptionException
Performs any necessary validation on the values added to the
CommandLine.
Validation will typically involve using the
CommandLine.getValues(option) method to retrieve the values
and then either checking each value. Optionally the String
value can be replaced by another Object such as a Number
instance or a File instance.
commandLine
- The CommandLine object to query.option
- The option to lookup values with.