net.dpml.cli
Interface Argument

All Superinterfaces:

Option

All Known Implementing Classes:

ArgumentImpl, SourceDestArgument

public interface Argument
extends Option

An Option that can process values passed on the command line in the form "--file README".

Version:

@PROJECT-VERSION@

Author:

@PUBLISHER-NAME@

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, java.util.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

getInitialSeparator

char getInitialSeparator()

Returns the initial separator character or '\0' if no character has been set.

Returns:

char the initial separator character

processValues

void processValues(WriteableCommandLine commandLine,
                   java.util.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.

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.

See Also:

WriteableCommandLine.addValue(Option,Object)

defaultValues

void defaultValues(WriteableCommandLine commandLine,
                   Option option)

Adds defaults to a CommandLine.

Parameters:

commandLine - the CommandLine object to store defaults in.

option - the Option to store the defaults against.

validate

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.

Parameters:

commandLine - The CommandLine object to query.

option - The option to lookup values with.

Throws:

OptionException - if any problems occur.

See Also:

CommandLine.getValues(Option)

isRequired

boolean isRequired()

Indicates whether argument values must be present for the CommandLine to be valid.

Specified by:

isRequired in interface Option

Returns:

true iff the CommandLine will be invalid without at least one value

See Also:

getMinimum(), getMaximum()

getMinimum

int getMinimum()

Retrieves the minimum number of values required for a valid Argument

Returns:

the minimum number of values

getMaximum

int getMaximum()

Retrieves the maximum number of values acceptable for a valid Argument

Returns:

the maximum number of values