com.google.devtools.common.options

Interface OptionsProvider

All Superinterfaces:

OptionsClassProvider

All Known Implementing Classes:

OptionsParser

public interface OptionsProvider
extends OptionsClassProvider

A read-only interface for options parser results, which does not allow any further parsing of options.

Field Summary

Fields inherited from interface com.google.devtools.common.options.OptionsClassProvider

EMPTY

Method Summary

Modifier and Type	Method and Description
java.util.List<OptionsParser.OptionValueDescription>	asListOfEffectiveOptions() Returns a list of all options, including undocumented ones, and their effective values.
java.util.List<OptionsParser.UnparsedOptionValueDescription>	asListOfExplicitOptions() Returns a list of all explicitly specified options, suitable for logging or for displaying back to the user.
java.util.List<OptionsParser.UnparsedOptionValueDescription>	asListOfUnparsedOptions() Returns a mutable copy of the list of all options that were specified either explicitly or implicitly.
java.util.List<java.lang.String>	canonicalize() Canonicalizes the list of options that this OptionsParser has parsed.
boolean	containsExplicitOption(java.lang.String string) Returns if the named option was specified explicitly in a call to parse.
java.util.List<java.lang.String>	getResidue() Returns an immutable copy of the residue, that is, the arguments that have not been parsed.

Methods inherited from interface com.google.devtools.common.options.OptionsClassProvider

getOptions

Method Detail

getResidue

java.util.List<java.lang.String> getResidue()

Returns an immutable copy of the residue, that is, the arguments that have not been parsed.

containsExplicitOption

boolean containsExplicitOption(java.lang.String string)

Returns if the named option was specified explicitly in a call to parse.

asListOfUnparsedOptions

java.util.List<OptionsParser.UnparsedOptionValueDescription> asListOfUnparsedOptions()

Returns a mutable copy of the list of all options that were specified either explicitly or implicitly. These options are sorted by priority, and by the order in which they were specified. If an option was specified multiple times, it is included in the result multiple times. Does not include the residue.

The returned list can be filtered if undocumented, hidden or implicit options should not be displayed.

asListOfExplicitOptions

java.util.List<OptionsParser.UnparsedOptionValueDescription> asListOfExplicitOptions()

Returns a list of all explicitly specified options, suitable for logging or for displaying back to the user. These options are sorted by priority, and by the order in which they were specified. If an option was explicitly specified multiple times, it is included in the result multiple times. Does not include the residue.

The list includes undocumented options.

asListOfEffectiveOptions

java.util.List<OptionsParser.OptionValueDescription> asListOfEffectiveOptions()

Returns a list of all options, including undocumented ones, and their effective values. There is no guaranteed ordering for the result.

canonicalize

java.util.List<java.lang.String> canonicalize()

Canonicalizes the list of options that this OptionsParser has parsed. The contract is that if the returned set of options is passed to an options parser with the same options classes, then that will have the same effect as using the original args (which are passed in here), except for cosmetic differences.