blob: 732301e63dae16e769c361a36c29a7390675f955 [file] [log] [blame]
// Copyright 2014 The Bazel Authors. 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.packages;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.packages.License.DistributionType;
import com.google.devtools.build.lib.starlarkbuildapi.TargetApi;
import com.google.devtools.build.lib.vfs.Path;
import java.util.List;
import java.util.Set;
import javax.annotation.Nullable;
/**
* A node in the build dependency graph, identified by a Label.
*
* <p>This StarlarkBuiltin does not contain any documentation since Starlark's Target type refers to
* TransitiveInfoCollection.class, which contains the appropriate documentation.
*/
public interface Target extends TargetApi, TargetData {
/**
* Returns the Package to which this rule belongs.
*/
Package getPackage();
/**
* Returns the rule associated with this target, if any.
*
* If this is a Rule, returns itself; it this is an OutputFile, returns its
* generating rule; if this is an input file, returns null.
*/
@Nullable
Rule getAssociatedRule();
/**
* Returns the license associated with this target.
*/
License getLicense();
/** Returns the set of distribution types associated with this target. */
Set<DistributionType> getDistributions();
/** Returns the visibility of this target. */
// TODO(jhorvitz): Usually one of the following two methods suffice. Try to remove this.
RuleVisibility getVisibility();
/**
* Equivalent to calling {@link RuleVisibility#getDependencyLabels} on the value returned by
* {@link #getVisibility}, but potentially more efficient.
*
* <p>Prefer this method over {@link #getVisibility} when only the dependency labels are needed
* and not a {@link RuleVisibility} instance.
*/
default Iterable<Label> getVisibilityDependencyLabels() {
return getVisibility().getDependencyLabels();
}
/**
* Equivalent to calling {@link RuleVisibility#getDeclaredLabels} on the value returned by {@link
* #getVisibility}, but potentially more efficient.
*
* <p>Prefer this method over {@link #getVisibility} when only the declared labels are needed and
* not a {@link RuleVisibility} instance.
*/
default List<Label> getVisibilityDeclaredLabels() {
return getVisibility().getDeclaredLabels();
}
/** Returns whether this target type can be configured (e.g. accepts non-null configurations). */
boolean isConfigurable();
@Override
default Path getPackageDirectory() {
return getPackage().getPackageDirectory();
}
}