aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java
diff options
context:
space:
mode:
authorGravatar Dmitry Lomov <dslomov@google.com>2016-12-02 23:51:05 +0000
committerGravatar Damien Martin-Guillerez <dmarting@google.com>2016-12-05 10:20:31 +0000
commit16d8fec128bee46dafe8bba0a45e6d7709dec792 (patch)
tree705f42affa7bc03bfd26b078707fb5b1fc05e00e /src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java
parent8d90a6d2a2114cc6c82bf76cbb01f2aa659ff41b (diff)
Add documentation for add{Skylark,Native}DeclaredProvider.
-- PiperOrigin-RevId: 140904064 MOS_MIGRATED_REVID=140904064
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java b/src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java
index 71b8d545e0..0047976e01 100644
--- a/src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java
+++ b/src/main/java/com/google/devtools/build/lib/analysis/RuleConfiguredTargetBuilder.java
@@ -285,6 +285,13 @@ public final class RuleConfiguredTargetBuilder {
return this;
}
+ /**
+ * Adds a "declared provider" defined in Skylark to the rule.
+ * Use this method for declared providers defined in Skyark.
+ *
+ * Use {@link #addNativeDeclaredProvider(SkylarkClassObject)} in definitions of
+ * native rules.
+ */
public RuleConfiguredTargetBuilder addSkylarkDeclaredProvider(
SkylarkClassObject provider, Location loc) throws EvalException {
SkylarkClassObjectConstructor constructor = provider.getConstructor();
@@ -298,6 +305,13 @@ public final class RuleConfiguredTargetBuilder {
return this;
}
+ /**
+ * Adds a "declared provider" defined in native code to the rule.
+ * Use this method for declared providers in definitions of native rules.
+ *
+ * Use {@link #addSkylarkDeclaredProvider(SkylarkClassObject, Location)}
+ * for Skylark rule implementations.
+ */
public RuleConfiguredTargetBuilder addNativeDeclaredProvider(SkylarkClassObject provider) {
SkylarkClassObjectConstructor constructor = provider.getConstructor();
Preconditions.checkState(constructor.isExported());