Uses of Class
com.aspectran.shell.command.option.Option
-
Packages that use Option Package Description com.aspectran.shell.command com.aspectran.shell.command.option A simple API for presenting, processing and validating a command line interface. -
-
Uses of Option in com.aspectran.shell.command
Methods in com.aspectran.shell.command with parameters of type Option Modifier and Type Method Description protected void
AbstractCommand. addOption(Option option)
-
Uses of Option in com.aspectran.shell.command.option
Methods in com.aspectran.shell.command.option that return Option Modifier and Type Method Description Option
Option.Builder. build()
Constructs an Option with the values declared by thisOption.Builder
.Option
Option. clone()
A rather odd clone method - due to incorrect code in 1.0 it is public and in 1.1 rather than throwing a CloneNotSupportedException it throws a RuntimeException so as to maintain backwards compat at the API level.Option
AlreadySelectedException. getOption()
Returns the option that was added to the group and triggered the exception.Option
MissingOptionValueException. getOption()
Return the option requiring a value that wasn't provided on the command line.Option
Options. getOption(java.lang.String name)
Retrieve theOption
matching the long or short name specified.Option[]
ParsedOptions. getOptions()
Returns an array of the processedOption
s.Methods in com.aspectran.shell.command.option that return types with arguments of type Option Modifier and Type Method Description java.util.Collection<Option>
Options. getAllOptions()
Retrieve a read-only list of options in this set.java.util.List<Option>
Options. getHelpOptions()
Returns the Options for use by the HelpFormatter.java.util.Comparator<Option>
HelpFormatter. getOptionComparator()
Comparator used to sort the options when they output in help text.java.util.Collection<Option>
OptionGroup. getOptions()
java.util.Iterator<Option>
ParsedOptions. iterator()
Returns an iterator over the Option members of ParsedOptions.Methods in com.aspectran.shell.command.option with parameters of type Option Modifier and Type Method Description OptionGroup
OptionGroup. addOption(Option option)
Add the specifiedOption
to this group.Options
Options. addOption(Option opt)
Adds an option instance.protected void
ParsedOptions. addOption(Option opt)
Add an option.OptionGroup
Options. getOptionGroup(Option opt)
Returns the OptionGroup theopt
belongs to.java.util.Properties
ParsedOptions. getProperties(Option option)
Retrieve the map of values associated to the option.<T> T
ParsedOptions. getTypedValue(Option option)
Return a version of thisOption
converted to a particular type.java.lang.String
ParsedOptions. getValue(Option option)
Retrieve the first argument, if any, of this option.java.lang.String
ParsedOptions. getValue(Option option, java.lang.String defaultValue)
Retrieve the first argument, if any, of an option.java.lang.String[]
ParsedOptions. getValues(Option option)
Retrieves the array of values, if any, of an option.boolean
ParsedOptions. hasOption(Option opt)
Query to see if an option has been set.void
OptionGroup. setSelected(Option option)
Set the selected option of this group toname
.Method parameters in com.aspectran.shell.command.option with type arguments of type Option Modifier and Type Method Description void
HelpFormatter. setOptionComparator(java.util.Comparator<Option> comparator)
Set the comparator used to sort the options when they output in help text.Constructors in com.aspectran.shell.command.option with parameters of type Option Constructor Description AlreadySelectedException(OptionGroup group, Option option)
Construct a newAlreadySelectedException
for the specified option group.MissingOptionValueException(Option option)
Construct a newMissingOptionValueException
with the specified detail message.
-