| /* |
| * Copyright 2012-present Facebook, Inc. |
| * |
| * 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.facebook.buck.rules; |
| |
| import com.facebook.buck.model.BuildTarget; |
| import com.facebook.buck.model.BuildTargetPattern; |
| import com.fasterxml.jackson.annotation.JsonAutoDetect; |
| import com.fasterxml.jackson.annotation.JsonProperty; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.common.collect.ImmutableSortedSet; |
| import com.google.common.util.concurrent.ListenableFuture; |
| |
| import java.io.IOException; |
| |
| import javax.annotation.Nullable; |
| |
| @JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE, |
| getterVisibility = JsonAutoDetect.Visibility.NONE, |
| setterVisibility = JsonAutoDetect.Visibility.NONE) |
| public interface BuildRule extends Comparable<BuildRule> { |
| |
| public BuildTarget getBuildTarget(); |
| |
| @JsonProperty("name") |
| public String getFullyQualifiedName(); |
| |
| @JsonProperty("type") |
| public BuildRuleType getType(); |
| |
| public BuildableProperties getProperties(); |
| |
| @Nullable |
| public Buildable getBuildable(); |
| |
| /** |
| * @return the set of rules that must be built before this rule. Normally, this matches the value |
| * of the {@code deps} argument for this build rule in the build file in which it was defined. |
| * <p> |
| * However, there are special cases where other arguments pull in implicit dependencies (e.g., |
| * the {@code keystore} argument in {@code android_binary}). In these cases, the implicit |
| * dependencies are also included in the set returned by this method. The value of the |
| * original {@code deps} argument, as defined in the build file, must be accessed via a |
| * custom getter provided by the build rule. |
| */ |
| public ImmutableSortedSet<BuildRule> getDeps(); |
| |
| /** |
| * @return the value of the "visibility" attribute for this build rule |
| */ |
| public ImmutableSet<BuildTargetPattern> getVisibilityPatterns(); |
| |
| /** |
| * @return whether this build rule is visible to the build target or not |
| */ |
| public boolean isVisibleTo(BuildTarget target); |
| |
| /** |
| * @return the inputs needed to build this build rule |
| */ |
| public Iterable<InputRule> getInputs(); |
| |
| /** |
| * This method must be idempotent. |
| */ |
| public ListenableFuture<BuildRuleSuccess> build(BuildContext context); |
| |
| /** |
| * Returns the way in which this rule was built. |
| * <p> |
| * <strong>IMPORTANT:</strong> This rule must have finished building before this method is |
| * invoked. |
| */ |
| public BuildRuleSuccess.Type getBuildResultType(); |
| |
| /** |
| * @return whether or not this rule exports its dependencies to all rules depending on it. |
| */ |
| public boolean getExportDeps(); |
| |
| /** |
| * @return key based on the BuildRule's state, including the transitive closure of its |
| * dependencies' keys. |
| */ |
| public RuleKey getRuleKey() throws IOException; |
| |
| /** |
| * Normally, a {@link RuleKey} is a function of the {@link RuleKey} of each of its deps as well as |
| * that of its inputs. This returns a {@link RuleKey} that is a function of only its inputs, which |
| * can be used to determine whether the definition or inputs of the rule changed independent of |
| * changes to its [transitive] deps. |
| * @return a non-null {@link RuleKey}. |
| */ |
| public RuleKey getRuleKeyWithoutDeps() throws IOException; |
| |
| /** @return the same value as {@link #getFullyQualifiedName()} */ |
| @Override |
| public String toString(); |
| } |