|
||||||||||
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.ParentImpl
org.apache.commons.cli2.option.Switch
public class Switch
A Parent implementation representing normal switch options.
For example: +d|-d
or --enable-x|--disable-x
.
Field Summary | |
---|---|
private java.util.Set |
aliases
|
static java.lang.String |
DEFAULT_DISABLED_PREFIX
The default prefix for disabled switches |
static java.lang.String |
DEFAULT_ENABLED_PREFIX
The default prefix for enabled switches |
private java.lang.Boolean |
defaultSwitch
|
private java.lang.String |
disabledPrefix
|
private java.lang.String |
enabledPrefix
|
private java.lang.String |
preferredName
|
private java.util.Set |
prefixes
|
static ResourceHelper |
resources
i18n |
private java.util.Set |
triggers
|
Constructor Summary | |
---|---|
Switch(java.lang.String enabledPrefix,
java.lang.String disabledPrefix,
java.lang.String preferredName,
java.util.Set aliases,
java.lang.String description,
boolean required,
Argument argument,
Group children,
int id,
java.lang.Boolean switchDefault)
Creates a new Switch with the specified parameters |
Method Summary | |
---|---|
void |
appendUsage(java.lang.StringBuffer buffer,
java.util.Set helpSettings,
java.util.Comparator comp)
Appends usage information to the specified StringBuffer |
void |
defaults(WriteableCommandLine commandLine)
Adds defaults to a CommandLine. |
java.lang.String |
getPreferredName()
The preferred name of an option is used for generating help and usage information. |
java.util.Set |
getPrefixes()
Identifies the argument prefixes that should be considered options. |
java.util.Set |
getTriggers()
Identifies the argument prefixes that should trigger this option. |
void |
processParent(WriteableCommandLine commandLine,
java.util.ListIterator arguments)
Processes the parent part of the Option. |
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.ParentImpl |
---|
canProcess, findOption, getArgument, getChildren, getDescription, helpLines, process |
Methods inherited from class org.apache.commons.cli2.option.OptionImpl |
---|
canProcess, checkPrefixes, equals, getId, hashCode, isRequired, 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, isRequired |
Field Detail |
---|
public static final ResourceHelper resources
public static final java.lang.String DEFAULT_ENABLED_PREFIX
public static final java.lang.String DEFAULT_DISABLED_PREFIX
private final java.lang.String enabledPrefix
private final java.lang.String disabledPrefix
private final java.util.Set triggers
private final java.lang.String preferredName
private final java.util.Set aliases
private final java.util.Set prefixes
private final java.lang.Boolean defaultSwitch
Constructor Detail |
---|
public Switch(java.lang.String enabledPrefix, java.lang.String disabledPrefix, java.lang.String preferredName, java.util.Set aliases, java.lang.String description, boolean required, Argument argument, Group children, int id, java.lang.Boolean switchDefault)
enabledPrefix
- the prefix used for enabled switchesdisabledPrefix
- the prefix used for disabled switchespreferredName
- the preferred name of the switchaliases
- the aliases by which the Switch is knowndescription
- a description of the Switchrequired
- whether the Option is strictly requiredargument
- the Argument belonging to this Parent, or nullchildren
- the Group children belonging to this Parent, ot nullid
- the unique identifier for this Option
java.lang.IllegalArgumentException
- if the preferredName or an alias isn't
prefixed with enabledPrefix or disabledPrefixMethod Detail |
---|
public void processParent(WriteableCommandLine commandLine, java.util.ListIterator arguments) throws OptionException
Parent
commandLine
- the CommandLine to write results toarguments
- a ListIterator over argument strings positioned at the next
argument to process
OptionException
- if an error occurs while processingOption.process(WriteableCommandLine, ListIterator)
public java.util.Set getTriggers()
Option
public java.util.Set getPrefixes()
Option
getPrefixes
in interface Option
getPrefixes
in class ParentImpl
public void validate(WriteableCommandLine commandLine) throws OptionException
Option
validate
in interface Option
validate
in class ParentImpl
commandLine
- The CommandLine to check.
OptionException
- if the CommandLine is not valid.public void appendUsage(java.lang.StringBuffer buffer, java.util.Set helpSettings, java.util.Comparator comp)
Option
appendUsage
in interface Option
appendUsage
in class ParentImpl
buffer
- the buffer to append tohelpSettings
- a set of display settings @see DisplaySettingcomp
- a comparator used to sort the Optionspublic java.lang.String getPreferredName()
Option
public void defaults(WriteableCommandLine commandLine)
Option
defaults
in interface Option
defaults
in class ParentImpl
commandLine
- The CommandLine object to store defaults in
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |