src/main/java/com/google/devtools/build/lib/skyframe/ConfiguredTargetAndTarget.java

// Copyright 2018 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.skyframe;

import com.google.common.base.Preconditions;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.Target;

/**
 * A container class for a {@link ConfiguredTarget} and {@link Target}. In the future, {@link
 * ConfiguredTarget} objects will no longer contain their associated {@link Target}. Consumers that
 * need the {@link Target} must therefore have access to one of these objects.
 *
 * <p>These objects are intended to be short-lived, never stored in Skyframe, since they pair two
 * heavyweight objects, a {@link ConfiguredTarget} and a {@link Target}, which holds a {@link
 * Package}.
 */
public class ConfiguredTargetAndTarget {
  private final ConfiguredTarget configuredTarget;
  private final Target target;

  ConfiguredTargetAndTarget(ConfiguredTarget configuredTarget, Target target) {
    this.configuredTarget = configuredTarget;
    this.target = target;
    Preconditions.checkState(
        configuredTarget.getTarget().equals(target),
        "%s %s %s",
        configuredTarget,
        target,
        configuredTarget.getTarget());
  }

  /**
   * For use with {@code MergedConfiguredTarget} and similar, where we create a virtual {@link
   * ConfiguredTarget} corresponding to the same {@link Target}.
   */
  public ConfiguredTargetAndTarget fromConfiguredTarget(ConfiguredTarget maybeNew) {
    if (configuredTarget.equals(maybeNew)) {
      return this;
    }
    return new ConfiguredTargetAndTarget(maybeNew, this.target);
  }

  public Target getTarget() {
    return target;
  }

  public ConfiguredTarget getConfiguredTarget() {
    return configuredTarget;
  }
}