net.dpml.cli
public interface Argument extends Option
Version: @PROJECT-VERSION@
Method Summary | |
---|---|
void | defaultValues(WriteableCommandLine commandLine, Option option)
Adds defaults to a CommandLine.
|
char | getInitialSeparator()
Returns the initial separator character or
'\0' if no character has been set.
|
int | getMaximum()
Retrieves the maximum number of values acceptable for a valid Argument
|
int | getMinimum()
Retrieves the minimum number of values required for a valid Argument
|
boolean | isRequired()
Indicates whether argument values must be present for the CommandLine to
be valid.
|
void | processValues(WriteableCommandLine commandLine, ListIterator args, Option option)
Processes the "README" style element of the argument.
|
void | validate(WriteableCommandLine commandLine, Option option)
Performs any necessary validation on the values added to the
CommandLine.
|
Parameters: commandLine the CommandLine object to store defaults in. option the Option to store the defaults against.
Returns: char the initial separator character
Returns: the maximum number of values
Returns: the minimum number of values
Returns: true iff the CommandLine will be invalid without at least one value
See Also: getMinimum getMaximum
Parameters: commandLine The CommandLine object to store results in. args The arguments to process. option The option to register value against.
Throws: OptionException if any problems occur.
Parameters: commandLine The CommandLine object to query. option The option to lookup values with.
Throws: OptionException if any problems occur.