com.google.devtools.common.options.OptionPriority Maven / Gradle / Ivy
Show all versions of google-options Show documentation
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.common.options;
/**
* 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 {@code DEFAULT}.
*
*
The ordering of the priorities is the source-code order. This is consistent
* with the automatically generated {@code 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.
*/
public enum OptionPriority {
/**
* The priority of values specified in the {@link Option} annotation. This
* should never be specified in calls to {@link OptionsParser#parse}.
*/
DEFAULT,
/**
* Overrides default options at runtime, while still allowing the values to be
* overridden manually.
*/
COMPUTED_DEFAULT,
/**
* For options coming from a configuration file or rc file.
*/
RC_FILE,
/**
* For options coming from the command line.
*/
COMMAND_LINE,
/**
* For options coming from invocation policy.
*/
INVOCATION_POLICY,
/**
* This priority can be used to unconditionally override any user-provided options.
* This should be used rarely and with caution!
*/
SOFTWARE_REQUIREMENT;
}