Index

A B C D E G H I L N O P R S T U V

A

asListOfEffectiveOptions() - Method in class com.google.devtools.common.options.OptionsParser
asListOfEffectiveOptions() - Method in interface com.google.devtools.common.options.OptionsProvider: Returns a list of all options, including undocumented ones, and their effective values.
asListOfExplicitOptions() - Method in class com.google.devtools.common.options.OptionsParser
asListOfExplicitOptions() - Method in interface com.google.devtools.common.options.OptionsProvider: Returns a list of all explicitly specified options, suitable for logging or for displaying back to the user.
asListOfUnparsedOptions() - Method in class com.google.devtools.common.options.OptionsParser
asListOfUnparsedOptions() - Method in interface com.google.devtools.common.options.OptionsProvider: Returns a mutable copy of the list of all options that were specified either explicitly or implicitly.
asMap() - Method in class com.google.devtools.common.options.OptionsBase: Returns this options object in the form of a (new) mapping from option names, including inherited ones, to option values.
AssignmentConverter() - Constructor for class com.google.devtools.common.options.Converters.AssignmentConverter

B

BooleanConverter() - Constructor for class com.google.devtools.common.options.Converters.BooleanConverter
BoolOrEnumConverter<T extends java.lang.Enum<T>> - Class in com.google.devtools.common.options: Converter that can also convert from booleans and enumerations.
BoolOrEnumConverter(Class<T>, String, T, T) - Constructor for class com.google.devtools.common.options.BoolOrEnumConverter: You *must* implement a zero-argument constructor that delegates to this constructor, passing in the appropriate parameters.

C

cacheKey() - Method in class com.google.devtools.common.options.OptionsBase: Returns a string that uniquely identifies the options.
canonicalize() - Method in class com.google.devtools.common.options.OptionsParser
canonicalize() - Method in interface com.google.devtools.common.options.OptionsProvider: Canonicalizes the list of options that this OptionsParser has parsed.
clearValue(String) - Method in class com.google.devtools.common.options.OptionsParser: Clears the given option.
ColonSeparatedOptionListConverter() - Constructor for class com.google.devtools.common.options.Converters.ColonSeparatedOptionListConverter
com.google.devtools.common.options - package com.google.devtools.common.options
CommaSeparatedOptionListConverter() - Constructor for class com.google.devtools.common.options.Converters.CommaSeparatedOptionListConverter
containsExplicitOption(String) - Method in class com.google.devtools.common.options.OptionsParser
containsExplicitOption(String) - Method in interface com.google.devtools.common.options.OptionsProvider: Returns if the named option was specified explicitly in a call to parse.
convert(String) - Method in class com.google.devtools.common.options.BoolOrEnumConverter
convert(String) - Method in interface com.google.devtools.common.options.Converter: Convert a string into type T.
convert(String) - Method in class com.google.devtools.common.options.Converters.AssignmentConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.BooleanConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.LengthLimitingConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.LogLevelConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.OptionalAssignmentConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.RangeConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.RegexPatternConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.SeparatedOptionListConverter
convert(String) - Method in class com.google.devtools.common.options.Converters.StringSetConverter
convert(String) - Method in class com.google.devtools.common.options.EnumConverter: Implements EnumConverter.convert(String).
Converter<T> - Interface in com.google.devtools.common.options: A converter is a little helper object that can take a String and turn it into an instance of type T (the type parameter to the converter).
Converters - Class in com.google.devtools.common.options: Some convenient converters used by blaze.
Converters() - Constructor for class com.google.devtools.common.options.Converters
Converters.AssignmentConverter - Class in com.google.devtools.common.options: A converter for variable assignments from the parameter list of a blaze command invocation.
Converters.BooleanConverter - Class in com.google.devtools.common.options: A converter for boolean values.
Converters.ColonSeparatedOptionListConverter - Class in com.google.devtools.common.options
Converters.CommaSeparatedOptionListConverter - Class in com.google.devtools.common.options
Converters.HelpVerbosityConverter - Class in com.google.devtools.common.options
Converters.LengthLimitingConverter - Class in com.google.devtools.common.options: Limits the length of a string argument.
Converters.LogLevelConverter - Class in com.google.devtools.common.options
Converters.OptionalAssignmentConverter - Class in com.google.devtools.common.options: A converter for variable assignments from the parameter list of a blaze command invocation.
Converters.RangeConverter - Class in com.google.devtools.common.options: Checks whether an integer is in the given range.
Converters.RegexPatternConverter - Class in com.google.devtools.common.options: Checks whether a string is a valid regex pattern and compiles it.
Converters.SeparatedOptionListConverter - Class in com.google.devtools.common.options
Converters.StringSetConverter - Class in com.google.devtools.common.options: Checks whether a string is part of a set of strings.

D

describeOptions(Map<String, String>, OptionsParser.HelpVerbosity) - Method in class com.google.devtools.common.options.OptionsParser: Returns a description of all the options this parser can digest.
describeOptionsHtml(Map<String, String>, Escaper) - Method in class com.google.devtools.common.options.OptionsParser: Returns a description of all the options this parser can digest.
DuplicateOptionDeclarationException - Exception in com.google.devtools.common.options: Indicates that an option is declared in more than one class.

E

EMPTY - Static variable in interface com.google.devtools.common.options.OptionsClassProvider
EnumConverter<T extends java.lang.Enum<T>> - Class in com.google.devtools.common.options: A converter superclass for converters that parse enums.
EnumConverter(Class<T>, String) - Constructor for class com.google.devtools.common.options.EnumConverter: Creates a new enum converter.
equals(Object) - Method in class com.google.devtools.common.options.OptionsBase

G

getAllowMultiple() - Method in class com.google.devtools.common.options.OptionsParser.OptionDescription
getConverter() - Method in class com.google.devtools.common.options.OptionsParser.OptionDescription
getDefaults(Class<O>) - Static method in class com.google.devtools.common.options.Options: Returns an options object at its default values.
getDefaultValue() - Method in class com.google.devtools.common.options.OptionsParser.OptionDescription
getExpansionParent() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
getImplicitDependant() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
getInvalidArgument() - Method in exception com.google.devtools.common.options.OptionsParsingException: Gets the name of the invalid argument or null if the exception can not determine the exact invalid arguments
getName() - Method in class com.google.devtools.common.options.OptionsParser.OptionDescription
getName() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
getName() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
getOptionDescription(String) - Method in class com.google.devtools.common.options.OptionsParser: Returns a description of the option.
getOptions() - Method in class com.google.devtools.common.options.Options: Returns an instance of options class O.
getOptions(Class<O>) - Method in interface com.google.devtools.common.options.OptionsClassProvider: Returns the options instance for the given optionsClass, that is, the parsed options, or null if it is not among those available.
getOptions(Class<O>) - Method in class com.google.devtools.common.options.OptionsParser
getOptionsCompletion() - Method in class com.google.devtools.common.options.OptionsParser: Returns a string listing the possible flag completion for this command along with the command completion if any.
getOptionsData(ImmutableList<Class<? extends OptionsBase>>) - Static method in class com.google.devtools.common.options.OptionsParser: Returns OpaqueOptionsData suitable for passing along to OptionsParser.newOptionsParser(OpaqueOptionsData optionsData).
getOptionValueDescription(String) - Method in class com.google.devtools.common.options.OptionsParser: Returns a description of the option value set by the last previous call to OptionsParser.parse(OptionPriority, String, List) that successfully set the given option.
getPriority() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
getRemainingArgs() - Method in class com.google.devtools.common.options.Options: Returns the arguments that we didn't parse.
getResidue() - Method in class com.google.devtools.common.options.OptionsParser
getResidue() - Method in interface com.google.devtools.common.options.OptionsProvider: Returns an immutable copy of the residue, that is, the arguments that have not been parsed.
getSource() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
getSource() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
getTypeDescription() - Method in interface com.google.devtools.common.options.Converter: The type description appears in usage messages.
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.AssignmentConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.BooleanConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.LengthLimitingConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.LogLevelConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.OptionalAssignmentConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.RangeConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.RegexPatternConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.SeparatedOptionListConverter
getTypeDescription() - Method in class com.google.devtools.common.options.Converters.StringSetConverter
getTypeDescription() - Method in class com.google.devtools.common.options.EnumConverter: Implements EnumConverter.getTypeDescription().
getUnparsedValue() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
getUsage(Class<? extends OptionsBase>) - Static method in class com.google.devtools.common.options.Options: Returns a usage string (renders the help information, the defaults, and of course the option names).
getValue() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
getWarnings() - Method in class com.google.devtools.common.options.OptionsParser: Returns a list of warnings about problems encountered by previous parse calls.

H

hashCode() - Method in class com.google.devtools.common.options.OptionsBase
HelpVerbosityConverter() - Constructor for class com.google.devtools.common.options.Converters.HelpVerbosityConverter

I

isBooleanOption() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
isDocumented() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
isExpansion() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
isExplicit() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
isHidden() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
isImplicitDependency() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription

L

LengthLimitingConverter(int) - Constructor for class com.google.devtools.common.options.Converters.LengthLimitingConverter
LEVELS - Static variable in class com.google.devtools.common.options.Converters.LogLevelConverter
LogLevelConverter() - Constructor for class com.google.devtools.common.options.Converters.LogLevelConverter

N

newOptionsParser(Class<? extends OptionsBase>) - Static method in class com.google.devtools.common.options.OptionsParser
newOptionsParser(Class<? extends OptionsBase>, Class<? extends OptionsBase>) - Static method in class com.google.devtools.common.options.OptionsParser
newOptionsParser(Iterable<? extends Class<? extends OptionsBase>>) - Static method in class com.google.devtools.common.options.OptionsParser: Create a new OptionsParser.
newOptionsParser(OpaqueOptionsData) - Static method in class com.google.devtools.common.options.OptionsParser: Create a new OptionsParser, using OpaqueOptionsData previously returned from OptionsParser.getOptionsData(com.google.common.collect.ImmutableList<java.lang.Class<? extends com.google.devtools.common.options.OptionsBase>>).

O

OpaqueOptionsData - Class in com.google.devtools.common.options: Opaque options data type, returned by OptionsParser.getOptionsData(com.google.common.collect.ImmutableList<java.lang.Class<? extends com.google.devtools.common.options.OptionsBase>>) and consumed by OptionsParser.newOptionsParser(OpaqueOptionsData).
Option - Annotation Type in com.google.devtools.common.options: An interface for annotating fields in classes (derived from OptionsBase) that are options.
OptionalAssignmentConverter() - Constructor for class com.google.devtools.common.options.Converters.OptionalAssignmentConverter
OptionDescription(String, Object, Converter<?>, boolean) - Constructor for class com.google.devtools.common.options.OptionsParser.OptionDescription
OptionPriority - Enum in com.google.devtools.common.options: The priority of option values, in order of increasing priority.
Options<O extends OptionsBase> - Class in com.google.devtools.common.options: Interface for parsing options from a single options specification class.
OptionsBase - Class in com.google.devtools.common.options: Base class for all options classes.
OptionsBase() - Constructor for class com.google.devtools.common.options.OptionsBase: Subclasses must provide a default (no argument) constructor.
OptionsClassProvider - Interface in com.google.devtools.common.options: A read-only interface for options parser results, which only allows to query the options of a specific class, but not e.g.
OptionsParser - Class in com.google.devtools.common.options: A parser for options.
OptionsParser.HelpVerbosity - Enum in com.google.devtools.common.options: The verbosity with which option help messages are displayed: short (just the name), medium (name, type, default, abbreviation), and long (full description).
OptionsParser.OptionDescription - Class in com.google.devtools.common.options: The metadata about an option.
OptionsParser.OptionValueDescription - Class in com.google.devtools.common.options: The name and value of an option with additional metadata describing its priority, source, whether it was set via an implicit dependency, and if so, by which other option.
OptionsParser.UnparsedOptionValueDescription - Class in com.google.devtools.common.options: The name and unparsed value of an option with additional metadata describing its priority, source, whether it was set via an implicit dependency, and if so, by which other option.
OptionsParsingException - Exception in com.google.devtools.common.options: An exception that's thrown when the OptionsParser fails.
OptionsParsingException(String) - Constructor for exception com.google.devtools.common.options.OptionsParsingException
OptionsParsingException(String, String) - Constructor for exception com.google.devtools.common.options.OptionsParsingException
OptionsParsingException(String, Throwable) - Constructor for exception com.google.devtools.common.options.OptionsParsingException
OptionsParsingException(String, String, Throwable) - Constructor for exception com.google.devtools.common.options.OptionsParsingException
OptionsProvider - Interface in com.google.devtools.common.options: A read-only interface for options parser results, which does not allow any further parsing of options.
OptionValueDescription(String, Object, OptionPriority, String, String, String) - Constructor for class com.google.devtools.common.options.OptionsParser.OptionValueDescription

P

parse(Class<O>, String...) - Static method in class com.google.devtools.common.options.Options: Parse the options provided in args, given the specification in optionsClass.
parse(String...) - Method in class com.google.devtools.common.options.OptionsParser: A convenience method, equivalent to parse(OptionPriority.COMMAND_LINE, null, Arrays.asList(args)).
parse(List<String>) - Method in class com.google.devtools.common.options.OptionsParser: A convenience method, equivalent to parse(OptionPriority.COMMAND_LINE, null, args).
parse(OptionPriority, String, List<String>) - Method in class com.google.devtools.common.options.OptionsParser: Parses args, using the classes registered with this parser.
parseAndExitUponError(String[]) - Method in class com.google.devtools.common.options.OptionsParser
parseAndExitUponError(OptionPriority, String, String[]) - Method in class com.google.devtools.common.options.OptionsParser: A convenience function for use in main methods.
parseWithSourceFunction(OptionPriority, Function<? super String, String>, List<String>) - Method in class com.google.devtools.common.options.OptionsParser: Parses args, using the classes registered with this parser.

R

RangeConverter(int, int) - Constructor for class com.google.devtools.common.options.Converters.RangeConverter
RegexPatternConverter() - Constructor for class com.google.devtools.common.options.Converters.RegexPatternConverter

S

SeparatedOptionListConverter(char, String) - Constructor for class com.google.devtools.common.options.Converters.SeparatedOptionListConverter
setAllowResidue(boolean) - Method in class com.google.devtools.common.options.OptionsParser: Indicates whether or not the parser will allow a non-empty residue; that is, iff this value is true then a call to one of the parse methods will throw OptionsParsingException unless OptionsParser.getResidue() is empty after parsing.
setAllowSingleDashLongOptions(boolean) - Method in class com.google.devtools.common.options.OptionsParser: Indicates whether or not the parser will allow long options with a single-dash, instead of the usual double-dash, too, eg.
StringSetConverter(String...) - Constructor for class com.google.devtools.common.options.Converters.StringSetConverter

T

toString() - Method in class com.google.devtools.common.options.OptionsBase
toString() - Method in class com.google.devtools.common.options.OptionsParser.OptionValueDescription
toString() - Method in class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription
TriState - Enum in com.google.devtools.common.options: Enum used to represent tri-state options (yes/no/auto).

U

UnparsedOptionValueDescription(String, Field, String, OptionPriority, String, boolean) - Constructor for class com.google.devtools.common.options.OptionsParser.UnparsedOptionValueDescription

V

valueOf(String) - Static method in enum com.google.devtools.common.options.OptionPriority: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.google.devtools.common.options.OptionsParser.HelpVerbosity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.google.devtools.common.options.TriState: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.google.devtools.common.options.OptionPriority: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.google.devtools.common.options.OptionsParser.HelpVerbosity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.google.devtools.common.options.TriState: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I L N O P R S T U V