com.google.devtools.common.options

Enum OptionPriority

java.lang.Object

java.lang.Enum<OptionPriority>

com.google.devtools.common.options.OptionPriority

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OptionPriority>

public enum OptionPriority
extends java.lang.Enum<OptionPriority>

The priority of option values, in order of increasing priority.

In general, new values for options can only override values with a lower or equal priority. Option values provided in annotations in an options class are implicitly at the priority DEFAULT.

The ordering of the priorities is the source-code order. This is consistent with the automatically generated compareTo method as specified by the Java Language Specification. DO NOT change the source-code order of these values, or you will break code that relies on the ordering.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMAND_LINE For options coming from the command line.
COMPUTED_DEFAULT Overrides default options at runtime, while still allowing the values to be overridden manually.
DEFAULT The priority of values specified in the Option annotation.
INVOCATION_POLICY For options coming from invocation policy.
RC_FILE For options coming from a configuration file or rc file.
SOFTWARE_REQUIREMENT This priority can be used to unconditionally override any user-provided options.

Method Summary

Modifier and Type	Method and Description
static OptionPriority	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OptionPriority[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final OptionPriority DEFAULT

The priority of values specified in the Option annotation. This should never be specified in calls to OptionsParser.parse(java.lang.String...).

COMPUTED_DEFAULT

public static final OptionPriority COMPUTED_DEFAULT

Overrides default options at runtime, while still allowing the values to be overridden manually.

RC_FILE

public static final OptionPriority RC_FILE

For options coming from a configuration file or rc file.

COMMAND_LINE

public static final OptionPriority COMMAND_LINE

For options coming from the command line.

INVOCATION_POLICY

public static final OptionPriority INVOCATION_POLICY

For options coming from invocation policy.

SOFTWARE_REQUIREMENT

public static final OptionPriority SOFTWARE_REQUIREMENT

This priority can be used to unconditionally override any user-provided options. This should be used rarely and with caution!

Method Detail

values

public static OptionPriority[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OptionPriority c : OptionPriority.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OptionPriority valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null