net.dpml.cli
Interface Parent

All Superinterfaces:
Option
All Known Implementing Classes:
Command, DefaultOption, ParentImpl, Switch

public interface Parent
extends Option

An Option that can have an argument and/or group of child Options in the form "-f <arg> [-a|-b|-c]".

Version:
1.0.0
Author:
Digital Product Meta Library

Method Summary
 void processParent(WriteableCommandLine commandLine, ListIterator args)
          Processes the parent part of the Option.
 
Methods inherited from interface net.dpml.cli.Option
appendUsage, canProcess, canProcess, defaults, findOption, getDescription, getId, getPreferredName, getPrefixes, getTriggers, helpLines, isRequired, process, validate
 

Method Detail

processParent

void processParent(WriteableCommandLine commandLine,
                   ListIterator args)
                   throws OptionException
Processes the parent part of the Option. The combination of parent, argument and children is handled by the process method.

Parameters:
commandLine - the CommandLine to write results to
args - a ListIterator over argument strings positioned at the next argument to process
Throws:
OptionException - if an error occurs while processing
See Also:
Option.process(WriteableCommandLine, ListIterator)