|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.cli2.option.OptionImpl
org.apache.commons.cli2.option.GroupImpl
public class GroupImpl
An implementation of Group
Constructor Summary | |
---|---|
GroupImpl(List options,
String name,
String description,
int minimum,
int maximum,
boolean required)
Creates a new GroupImpl using the specified parameters. |
Method Summary | |
---|---|
void |
appendUsage(StringBuffer buffer,
Set helpSettings,
Comparator comp)
Appends usage information to the specified StringBuffer |
void |
appendUsage(StringBuffer buffer,
Set helpSettings,
Comparator comp,
String separator)
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. |
void |
defaults(WriteableCommandLine commandLine)
Adds defaults to a CommandLine. |
Option |
findOption(String trigger)
Recursively searches for an option with the supplied trigger. |
List |
getAnonymous()
Gets the anonymous Arguments of this Group. |
String |
getDescription()
Returns a description of the option. |
int |
getMaximum()
Retrieves the maximum number of members acceptable for a valid Group |
int |
getMinimum()
Retrieves the minimum number of members required for a valid Group |
List |
getOptions()
Gets the member Options of thie Group. |
String |
getPreferredName()
The preferred name of an option is used for generating help and usage information. |
Set |
getPrefixes()
Identifies the argument prefixes that should be considered options. |
Set |
getTriggers()
Identifies the argument prefixes that should trigger this option. |
List |
helpLines(int depth,
Set helpSettings,
Comparator comp)
Builds up a list of HelpLineImpl instances to be presented by HelpFormatter. |
boolean |
isRequired()
Tests whether this option is required. |
void |
process(WriteableCommandLine commandLine,
ListIterator arguments)
Processes String arguments into a CommandLine. |
void |
validate(WriteableCommandLine commandLine)
Checks that the supplied CommandLine is valid with respect to this option. |
Methods inherited from class org.apache.commons.cli2.option.OptionImpl |
---|
canProcess, checkPrefixes, equals, getId, getParent, hashCode, setParent, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.commons.cli2.Option |
---|
canProcess, getId, getParent, setParent |
Constructor Detail |
---|
public GroupImpl(List options, String name, String description, int minimum, int maximum, boolean required)
options
- the Options and Arguments that make up the Groupname
- the name of this Group, or nulldescription
- a description of this Groupminimum
- the minimum number of Options for a valid CommandLinemaximum
- the maximum number of Options for a valid CommandLinerequired
- a flag whether this group is requiredMethod Detail |
---|
public boolean canProcess(WriteableCommandLine commandLine, String arg)
Option
canProcess
in interface Option
commandLine
- The CommandLine to checkarg
- The argument to be tested
public Set getPrefixes()
Option
getPrefixes
in interface Option
public Set getTriggers()
Option
getTriggers
in interface Option
public void process(WriteableCommandLine commandLine, ListIterator arguments) throws OptionException
Option
process
in interface Option
commandLine
- The CommandLine object to store results inarguments
- The arguments to process
OptionException
- if any problems occurpublic void validate(WriteableCommandLine commandLine) throws OptionException
Option
validate
in interface Option
commandLine
- The CommandLine to check.
OptionException
- if the CommandLine is not valid.public String getPreferredName()
Option
getPreferredName
in interface Option
public String getDescription()
Option
getDescription
in interface Option
HelpFormatter
public void appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp)
Option
appendUsage
in interface Option
buffer
- the buffer to append tohelpSettings
- a set of display settings @see DisplaySettingcomp
- a comparator used to sort the Optionspublic void appendUsage(StringBuffer buffer, Set helpSettings, Comparator comp, String separator)
Group
appendUsage
in interface Group
buffer
- the buffer to append tohelpSettings
- a set of display settings @see DisplaySettingcomp
- a comparator used to sort the Optionsseparator
- the String used to separate member Optionspublic List helpLines(int depth, Set helpSettings, Comparator comp)
Option
helpLines
in interface Option
depth
- the initial indent depthhelpSettings
- the HelpSettings that should be appliedcomp
- a comparator used to sort options when applicable.
HelpLine
,
HelpFormatter
public List getOptions()
public List getAnonymous()
public Option findOption(String trigger)
Option
findOption
in interface Option
findOption
in class OptionImpl
trigger
- the trigger to search for.
public int getMinimum()
Group
getMinimum
in interface Group
public int getMaximum()
Group
getMaximum
in interface Group
public boolean isRequired()
required
flag common to all options, but also take the
minimum constraints into account.
isRequired
in interface Group
isRequired
in interface Option
isRequired
in class OptionImpl
Group.getMinimum()
,
Group.getMaximum()
public void defaults(WriteableCommandLine commandLine)
Option
defaults
in interface Option
defaults
in class OptionImpl
commandLine
- The CommandLine object to store defaults in
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |