|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use Option | |
net.dpml.cli | Commandline modeling and parsing utilities. |
net.dpml.cli.builder | Helpers supporting the construction of a commandline model. |
net.dpml.cli.commandline | Commandline implementation. |
net.dpml.cli.option | Options implementation include command, group, switch and property abstractions. |
Uses of Option in net.dpml.cli |
Subinterfaces of Option in net.dpml.cli | |
interface |
Argument
An Option that can process values passed on the command line in the form "--file README". |
interface |
Group
An Option representing a choice or group of Options in the form "-a|-b|-c". |
interface |
Parent
An Option that can have an argument and/or group of child Options in the form "-f <arg> [-a|-b|-c]". |
Methods in net.dpml.cli that return Option | |
Option |
OptionException.getOption()
Gets the Option the exception relates to |
Option |
Option.findOption(String trigger)
Recursively searches for an option with the supplied trigger. |
Option |
HelpLine.getOption()
|
Option |
CommandLine.getOption(String trigger)
Finds the Option with the specified trigger |
Methods in net.dpml.cli with parameters of type Option | |
void |
WriteableCommandLine.addOption(Option option)
Adds an Option to the CommandLine |
void |
WriteableCommandLine.addValue(Option option,
Object value)
Adds a value to an Option in the CommandLine. |
void |
WriteableCommandLine.setDefaultValues(Option option,
List defaultValues)
Sets the default values for an Option in the CommandLine |
void |
WriteableCommandLine.addSwitch(Option option,
boolean value)
Adds a switch value to an Option in the CommandLine. |
void |
WriteableCommandLine.setDefaultSwitch(Option option,
Boolean defaultSwitch)
Sets the default state for a Switch in the CommandLine. |
boolean |
CommandLine.hasOption(Option option)
Detects the presence of an option in this CommandLine. |
List |
CommandLine.getValues(Option option)
Retrieves the Argument values associated with the specified Option |
List |
CommandLine.getValues(Option option,
List defaultValues)
Retrieves the Argument values associated with the specified Option |
Object |
CommandLine.getValue(Option option)
Retrieves the single Argument value associated with the specified Option |
Object |
CommandLine.getValue(Option option,
Object defaultValue)
Retrieves the single Argument value associated with the specified Option |
Boolean |
CommandLine.getSwitch(Option option)
Retrieves the Boolean value associated with the specified Switch |
Boolean |
CommandLine.getSwitch(Option option,
Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch |
int |
CommandLine.getOptionCount(Option option)
Retrieves the number of times the specified Option appeared in this CommandLine |
void |
Argument.processValues(WriteableCommandLine commandLine,
ListIterator args,
Option option)
Processes the "README" style element of the argument. |
void |
Argument.defaultValues(WriteableCommandLine commandLine,
Option option)
Adds defaults to a CommandLine. |
void |
Argument.validate(WriteableCommandLine commandLine,
Option option)
Performs any necessary validation on the values added to the CommandLine. |
Constructors in net.dpml.cli with parameters of type Option | |
OptionException(Option option)
Creates a new OptionException. |
|
OptionException(Option option,
String messageKey)
Creates a new OptionException. |
|
OptionException(Option option,
String messageKey,
String value)
Creates a new OptionException. |
Uses of Option in net.dpml.cli.builder |
Methods in net.dpml.cli.builder that return Option | |
Option |
PatternBuilder.create()
Creates a new Option instance. |
Methods in net.dpml.cli.builder with parameters of type Option | |
GroupBuilder |
GroupBuilder.withOption(Option option)
Add this option to the group |
Uses of Option in net.dpml.cli.commandline |
Methods in net.dpml.cli.commandline that return Option | |
Option |
WriteableCommandLineImpl.getOption(String trigger)
Finds the Option with the specified trigger |
Option |
PropertiesCommandLine.getOption(String trigger)
Finds the Option with the specified trigger |
Option |
PreferencesCommandLine.getOption(String trigger)
Finds the Option with the specified trigger |
Option |
DefaultingCommandLine.getOption(String trigger)
Finds the Option with the specified trigger |
Methods in net.dpml.cli.commandline with parameters of type Option | |
void |
WriteableCommandLineImpl.addOption(Option option)
Add an option. |
void |
WriteableCommandLineImpl.addValue(Option option,
Object value)
Add an option. |
void |
WriteableCommandLineImpl.addSwitch(Option option,
boolean value)
Add a switch. |
boolean |
WriteableCommandLineImpl.hasOption(Option option)
Detects the presence of an option in this CommandLine. |
List |
WriteableCommandLineImpl.getValues(Option option,
List defaultValues)
Retrieves the Argument values associated with the specified Option |
Boolean |
WriteableCommandLineImpl.getSwitch(Option option,
Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch |
void |
WriteableCommandLineImpl.setDefaultValues(Option option,
List defaults)
Set default values. |
void |
WriteableCommandLineImpl.setDefaultSwitch(Option option,
Boolean defaultSwitch)
Set default switch. |
boolean |
PropertiesCommandLine.hasOption(Option option)
Detects the presence of an option in this CommandLine. |
List |
PropertiesCommandLine.getValues(Option option,
List defaultValues)
Retrieves the Argument values associated with the specified Option |
Boolean |
PropertiesCommandLine.getSwitch(Option option,
Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch |
boolean |
PreferencesCommandLine.hasOption(Option option)
Detects the presence of an option in this CommandLine. |
List |
PreferencesCommandLine.getValues(Option option,
List defaultValues)
Retrieves the Argument values associated with the specified Option |
Boolean |
PreferencesCommandLine.getSwitch(Option option,
Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch |
void |
Parser.setHelpOption(Option helpOption)
Sets the help option to use with the simplified parsing. |
boolean |
DefaultingCommandLine.hasOption(Option option)
Detects the presence of an option in this CommandLine. |
List |
DefaultingCommandLine.getValues(Option option,
List defaultValues)
Retrieves the Argument values associated with the specified Option |
Boolean |
DefaultingCommandLine.getSwitch(Option option,
Boolean defaultValue)
Retrieves the Boolean value associated with the specified Switch |
List |
CommandLineImpl.getValues(Option option)
Retrieves the Argument values associated with the specified Option |
Object |
CommandLineImpl.getValue(Option option)
Retrieves the single Argument value associated with the specified Option |
Object |
CommandLineImpl.getValue(Option option,
Object defaultValue)
Retrieves the single Argument value associated with the specified Option |
Boolean |
CommandLineImpl.getSwitch(Option option)
Retrieves the Boolean value associated with the specified Switch |
int |
CommandLineImpl.getOptionCount(Option option)
Retrieves the number of times the specified Option appeared in this CommandLine |
Constructors in net.dpml.cli.commandline with parameters of type Option | |
WriteableCommandLineImpl(Option rootOption,
List arguments)
Creates a new WriteableCommandLineImpl rooted on the specified Option, to hold the parsed arguments. |
|
PropertiesCommandLine(Option root,
Properties properties)
Creates a new PropertiesCommandLine using the specified root Option, Properties instance. |
|
PropertiesCommandLine(Option root,
Properties properties,
char separator)
Creates a new PropertiesCommandLine using the specified root Option, Properties instance and value separator. |
|
PreferencesCommandLine(Option root,
Preferences preferences)
Creates a new PreferencesCommandLine using the specified root Option and Preferences node. |
|
PreferencesCommandLine(Option root,
Preferences preferences,
char separator)
Creates a new PreferencesCommandLine using the specified root Option, Preferences node and value separator. |
Uses of Option in net.dpml.cli.option |
Classes in net.dpml.cli.option that implement Option | |
class |
ArgumentImpl
An implementation of an Argument. |
class |
Command
Represents a cvs "update" style command line option. |
class |
DefaultOption
A Parent implementation representing normal options. |
class |
GroupImpl
An implementation of Group |
class |
OptionImpl
A base implementation of Option providing limited ground work for further Option implementations. |
class |
ParentImpl
A base implementation of Parent providing limited ground work for further Parent implementations. |
class |
PropertyOption
Handles the java style "-Dprop=value" opions |
class |
SourceDestArgument
An Argument implementation that allows a variable size Argument to precede a fixed size argument. |
class |
Switch
A Parent implementation representing normal switch options. |
Methods in net.dpml.cli.option that return Option | |
Option |
ParentImpl.findOption(String trigger)
Recursively searches for an option with the supplied trigger. |
Option |
OptionImpl.findOption(String trigger)
Recursively searches for an option with the supplied trigger. |
Option |
HelpLineImpl.getOption()
|
Option |
GroupImpl.findOption(String trigger)
Recursively searches for an option with the supplied trigger. |
Methods in net.dpml.cli.option with parameters of type Option | |
void |
SourceDestArgument.validate(WriteableCommandLine commandLine,
Option option)
Checks that the supplied CommandLine is valid with respect to the suppled option. |
void |
ArgumentImpl.processValues(WriteableCommandLine commandLine,
ListIterator arguments,
Option option)
Processes the "README" style element of the argument. |
void |
ArgumentImpl.validate(WriteableCommandLine commandLine,
Option option)
Performs any necessary validation on the values added to the CommandLine. |
void |
ArgumentImpl.defaultValues(WriteableCommandLine commandLine,
Option option)
Adds defaults to a CommandLine. |
Constructors in net.dpml.cli.option with parameters of type Option | |
HelpLineImpl(Option option,
int indent)
Creates a new HelpLineImpl to represent a particular Option in the online help. |
|
|||||||||||
PREV NEXT | FRAMES NO FRAMES |