src/main/java/com/google/devtools/build/lib/analysis/ConfigurationCollectionFactory.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
46
47
48
49
50
51
52
53
54

// 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;

import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.ConfigurationFactory;
import com.google.devtools.build.lib.analysis.config.InvalidConfigurationException;
import com.google.devtools.build.lib.analysis.config.PackageProviderForConfigurations;
import com.google.devtools.build.lib.events.EventHandler;

import java.util.Map;

import javax.annotation.Nullable;

/**
 * A factory for configuration collection creation.
 */
public interface ConfigurationCollectionFactory {
  /**
   * Creates the top-level configuration for a build.
   *
   * <p>Also it may create a set of BuildConfigurations and define a transition table over them.
   * All configurations during a build should be accessible from this top-level configuration
   * via configuration transitions.
   * @param loadedPackageProvider the package provider
   * @param buildOptions top-level build options representing the command-line
   * @param clientEnv the system environment
   * @param errorEventListener the event listener for errors
   * @param performSanityCheck flag to signal about performing sanity check. Can be false only for
   * tests in skyframe. Legacy mode uses loadedPackageProvider == null condition for this.
   * @return the top-level configuration
   * @throws InvalidConfigurationException
   */
  @Nullable
  public BuildConfiguration createConfigurations(
      ConfigurationFactory configurationFactory,
      PackageProviderForConfigurations loadedPackageProvider,
      BuildOptions buildOptions,
      Map<String, String> clientEnv,
      EventHandler errorEventListener,
      boolean performSanityCheck) throws InvalidConfigurationException;
}