|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Argument
An Option that can process values passed on the command line in the form "--file README".
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. |
Methods inherited from interface net.dpml.cli.Option |
---|
appendUsage, canProcess, canProcess, defaults, findOption, getDescription, getId, getPreferredName, getPrefixes, getTriggers, helpLines, process, validate |
Method Detail |
---|
char getInitialSeparator()
void processValues(WriteableCommandLine commandLine, ListIterator args, Option option) throws OptionException
commandLine
- The CommandLine object to store results in.args
- The arguments to process.option
- The option to register value against.
OptionException
- if any problems occur.WriteableCommandLine.addValue(Option,Object)
void defaultValues(WriteableCommandLine commandLine, Option option)
commandLine
- the CommandLine object to store defaults in.option
- the Option to store the defaults against.void validate(WriteableCommandLine commandLine, Option option) throws OptionException
commandLine
- The CommandLine object to query.option
- The option to lookup values with.
OptionException
- if any problems occur.CommandLine.getValues(Option)
boolean isRequired()
isRequired
in interface Option
getMinimum()
,
getMaximum()
int getMinimum()
int getMaximum()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |