Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

net.dpml.cli.option

Class SourceDestArgument

Implemented Interfaces:
Argument, Option
public class SourceDestArgument
extends ArgumentImpl
An Argument implementation that allows a variable size Argument to precede a fixed size argument. The canonical example of it's use is in the unix cp command where a number of source can be specified with exactly one destination specfied at the end.
Version:
@PROJECT-VERSION@
Author:
@PUBLISHER-NAME@

Field Summary

Fields inherited from class net.dpml.cli.option.ArgumentImpl

DEFAULT_CONSUME_REMAINING, DEFAULT_INITIAL_SEPARATOR, DEFAULT_SUBSEQUENT_SEPARATOR

Constructor Summary

SourceDestArgument(Argument source, Argument dest)
Creates a SourceDestArgument using defaults where possible.
SourceDestArgument(Argument source, Argument dest, char initialSeparator, char subsequentSeparator, String consumeRemaining, List defaultValues)
Creates a SourceDestArgument using the specified parameters.

Method Summary

void
appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Appends usage information to the specified StringBuffer
boolean
canProcess(WriteableCommandLine commandLine, String arg)
Indicates whether this Option will be able to process the particular argument.
List
helpLines(int depth, Set helpSettings, Comparator comp)
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
void
validate(WriteableCommandLine commandLine, Option option)
Checks that the supplied CommandLine is valid with respect to the suppled option.

Methods inherited from class net.dpml.cli.option.ArgumentImpl

appendUsage, canProcess, defaultValues, defaults, getConsumeRemaining, getDefaultValues, getDescription, getInitialSeparator, getMaximum, getMinimum, getPreferredName, getPrefixes, getSubsequentSeparator, getTriggers, getValidator, helpLines, isRequired, process, processValues, stripBoundaryQuotes, validate, validate

Methods inherited from class net.dpml.cli.option.OptionImpl

canProcess, checkPrefixes, defaults, equals, findOption, getId, hashCode, isRequired, toString

Constructor Details

SourceDestArgument

public SourceDestArgument(Argument source,
                          Argument dest)
Creates a SourceDestArgument using defaults where possible.
Parameters:
source - the variable size Argument
dest - the fixed size Argument

SourceDestArgument

public SourceDestArgument(Argument source,
                          Argument dest,
                          char initialSeparator,
                          char subsequentSeparator,
                          String consumeRemaining,
                          List defaultValues)
Creates a SourceDestArgument using the specified parameters.
Parameters:
source - the variable size Argument
dest - the fixed size Argument
initialSeparator - the inistial separator to use
subsequentSeparator - the subsequent separator to use
consumeRemaining - the token triggering consume remaining behaviour
defaultValues - the default values for the SourceDestArgument

Method Details

appendUsage

public void appendUsage(StringBuffer buffer,
                        Set helpSettings,
                        Comparator comp)
Appends usage information to the specified StringBuffer
Specified by:
appendUsage in interface Option
Overrides:
appendUsage in interface ArgumentImpl
Parameters:
buffer - the buffer to append to
helpSettings - a set of display settings @see DisplaySetting
comp - a comparator used to sort the Options

canProcess

public boolean canProcess(WriteableCommandLine commandLine,
                          String arg)
Indicates whether this Option will be able to process the particular argument.
Specified by:
canProcess in interface Option
Overrides:
canProcess in interface ArgumentImpl
Parameters:
commandLine - the CommandLine object to store defaults in
arg - the argument to be tested
Returns:
true if the argument can be processed by this Option

helpLines

public List helpLines(int depth,
                      Set helpSettings,
                      Comparator comp)
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter.
Specified by:
helpLines in interface Option
Overrides:
helpLines in interface ArgumentImpl
Parameters:
depth - the initial indent depth
helpSettings - the HelpSettings that should be applied
comp - a comparator used to sort options when applicable.
Returns:
a List of HelpLineImpl objects
See Also:
HelpLine, HelpFormatter

validate

public void validate(WriteableCommandLine commandLine,
                     Option option)
            throws OptionException
Checks that the supplied CommandLine is valid with respect to the suppled option.
Specified by:
validate in interface Argument
Overrides:
validate in interface ArgumentImpl
Parameters:
commandLine - the CommandLine to check.
option - the option to evaluate
Throws:
OptionException - if the CommandLine is not valid.

Overview Package Class Use Source Tree Index Deprecated About