src/main/java/com/google/devtools/build/lib/analysis/config/ConfigurationFragmentFactory.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

// Copyright 2014 Google Inc. 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.build.lib.analysis.config;

import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration.Fragment;

import javax.annotation.Nullable;

/**
 * A factory that creates configuration fragments.
 */
public interface ConfigurationFragmentFactory {
  /**
   * Creates a configuration fragment.
   *
   * @param env the ConfigurationEnvironment for querying targets and paths
   * @param buildOptions command-line options (see {@link FragmentOptions})
   * @return the configuration fragment or null if some required dependencies are missing.
   */
  @Nullable
  BuildConfiguration.Fragment create(ConfigurationEnvironment env, BuildOptions buildOptions)
      throws InvalidConfigurationException;

  /**
   * @return the exact type of the fragment this factory creates.
   */
  Class<? extends Fragment> creates();

  /**
   * Returns the option classes needed to load this fragment.
   */
  ImmutableSet<Class<? extends FragmentOptions>> requiredOptions();
}