// 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.analysis; import com.google.devtools.build.lib.analysis.config.BuildConfiguration; import com.google.devtools.build.lib.packages.Target; import javax.annotation.Nullable; /** * A {@link ConfiguredTarget} is conceptually a {@link TransitiveInfoCollection} coupled * with the {@link Target} and {@link BuildConfiguration} objects it was created from. * *
This interface is supposed to only be used in {@link BuildView} and above. In particular,
* rule implementations should not be able to access the {@link ConfiguredTarget} objects
* associated with their direct dependencies, only the corresponding
* {@link TransitiveInfoCollection}s. Also, {@link ConfiguredTarget} objects should not be
* accessible from the action graph.
*/
public interface ConfiguredTarget extends TransitiveInfoCollection {
/**
* All ConfiguredTarget
s have a "label" field.
*/
String LABEL_FIELD = "label";
/**
* All ConfiguredTarget
s have a "aspect_ids" field.
*/
String ASPECTS_FIELD = "aspect_ids";
/**
* All ConfiguredTarget
s have a "files" field.
*/
String FILES_FIELD = "files";
/**
* Returns the Target with which this {@link ConfiguredTarget} is associated.
*/
Target getTarget();
/**
*
Returns the {@link BuildConfiguration} for which this {@link ConfiguredTarget} is * defined. Configuration is defined for all configured targets with exception * of the {@link InputFileConfiguredTarget} for which it is always * null.
*/ @Override @Nullable BuildConfiguration getConfiguration(); }