aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules/java/JavaCompilationArgsProvider.java
blob: 1958ada5445872a4953126e8faf6a2f2af551232 (plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
// 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.rules.java;

import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.TransitiveInfoProvider;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;

/**
 * An interface for objects that provide information on how to include them in
 * Java builds.
 */
@Immutable
public final class JavaCompilationArgsProvider implements TransitiveInfoProvider {
  private final JavaCompilationArgs javaCompilationArgs;
  private final JavaCompilationArgs recursiveJavaCompilationArgs;
  private final NestedSet<Artifact> compileTimeJavaDepArtifacts;
  private final NestedSet<Artifact> runTimeJavaDepArtifacts;

  public JavaCompilationArgsProvider(JavaCompilationArgs javaCompilationArgs,
      JavaCompilationArgs recursiveJavaCompilationArgs,
      NestedSet<Artifact> compileTimeJavaDepArtifacts,
      NestedSet<Artifact> runTimeJavaDepArtifacts) {
    this.javaCompilationArgs = javaCompilationArgs;
    this.recursiveJavaCompilationArgs = recursiveJavaCompilationArgs;
    this.compileTimeJavaDepArtifacts = compileTimeJavaDepArtifacts;
    this.runTimeJavaDepArtifacts = runTimeJavaDepArtifacts;
  }

  public JavaCompilationArgsProvider(JavaCompilationArgs javaCompilationArgs,
      JavaCompilationArgs recursiveJavaCompilationArgs) {
    this.javaCompilationArgs = javaCompilationArgs;
    this.recursiveJavaCompilationArgs = recursiveJavaCompilationArgs;
    this.compileTimeJavaDepArtifacts = NestedSetBuilder.<Artifact>emptySet(Order.STABLE_ORDER);
    this.runTimeJavaDepArtifacts = NestedSetBuilder.<Artifact>emptySet(Order.STABLE_ORDER);
  }

  /**
   * Returns non-recursively collected Java compilation information for
   * building this target (called when strict_java_deps = 1).
   *
   * <p>Note that some of the parameters are still collected from the complete
   * transitive closure. The non-recursive collection applies mainly to
   * compile-time jars.
   */
  public JavaCompilationArgs getJavaCompilationArgs() {
    return javaCompilationArgs;
  }

  /**
   * Returns recursively collected Java compilation information for building
   * this target (called when strict_java_deps = 0).
   */
  public JavaCompilationArgs getRecursiveJavaCompilationArgs() {
    return recursiveJavaCompilationArgs;
  }

  /**
   * Returns non-recursively collected Java dependency artifacts for
   * computing a restricted classpath when building this target (called when
   * strict_java_deps = 1).
   *
   * <p>Note that dependency artifacts are needed only when non-recursive
   * compilation args do not provide a safe super-set of dependencies.
   * Non-strict targets such as proto_library, always collecting their
   * transitive closure of deps, do not need to provide dependency artifacts.
   */
  public NestedSet<Artifact> getCompileTimeJavaDependencyArtifacts() {
    return compileTimeJavaDepArtifacts;
  }

  /**
   * Returns Java dependency artifacts for computing a restricted run-time
   * classpath (called when strict_java_deps = 1).
   */
  public NestedSet<Artifact> getRunTimeJavaDependencyArtifacts() {
    return runTimeJavaDepArtifacts;
  }
}