Home | History | Annotate | Download | only in options
      1 // Copyright 2017 The Bazel Authors. All rights reserved.
      2 //
      3 // Licensed under the Apache License, Version 2.0 (the "License");
      4 // you may not use this file except in compliance with the License.
      5 // You may obtain a copy of the License at
      6 //
      7 //    http://www.apache.org/licenses/LICENSE-2.0
      8 //
      9 // Unless required by applicable law or agreed to in writing, software
     10 // distributed under the License is distributed on an "AS IS" BASIS,
     11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     12 // See the License for the specific language governing permissions and
     13 // limitations under the License.
     14 package com.google.devtools.common.options;
     15 
     16 import com.google.common.collect.ImmutableList;
     17 
     18 /**
     19  * A function from an option parser's static setup (what flags it knows about) to a list of
     20  * expansion Strings to use for one of its options.
     21  */
     22 @FunctionalInterface
     23 public interface ExpansionFunction {
     24 
     25   /**
     26    * Compute the expansion for an option. May be called at any time during or after the {@link
     27    * OptionsParser}'s construction, or not at all.
     28    *
     29    * @param optionsData the parser's indexed information about its own options, before expansion
     30    *     information is computed
     31    * @return An expansion to use on an empty list
     32    */
     33   ImmutableList<String> getExpansion(IsolatedOptionsData optionsData);
     34 }
     35