src/main/java/com/google/devtools/build/lib/analysis/TargetAndConfiguration.java

// Copyright 2014 Google Inc. 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.common.base.Function;
import com.google.common.base.Preconditions;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.skyframe.ConfiguredTargetKey;
import com.google.devtools.build.lib.syntax.Label;

import java.util.Objects;

import javax.annotation.Nullable;

/**
 * Refers to the pair of a target and a configuration and certain additional information. Not the
 * same as {@link ConfiguredTarget} -- that also contains the result of the analysis phase.
 */
public class TargetAndConfiguration {
  private final Target target;
  @Nullable private final BuildConfiguration configuration;

  public TargetAndConfiguration(Target target, @Nullable BuildConfiguration configuration) {
    this.target = Preconditions.checkNotNull(target);
    this.configuration = configuration;
  }

  public TargetAndConfiguration(ConfiguredTarget configuredTarget) {
    this.target = Preconditions.checkNotNull(configuredTarget).getTarget();
    this.configuration = configuredTarget.getConfiguration();
  }

  // The node name in the graph. The name should be unique.
  // It is not suitable for user display.
  public String getName() {
    return target.getLabel() + " "
        + (configuration == null ? "null" : configuration.checksum());
  }

  public static final Function<TargetAndConfiguration, String> NAME_FUNCTION =
      new Function<TargetAndConfiguration, String>() {
        @Override
        public String apply(TargetAndConfiguration node) {
          return node.getName();
        }
      };

  public static final Function<TargetAndConfiguration, ConfiguredTargetKey>
      TO_LABEL_AND_CONFIGURATION = new Function<TargetAndConfiguration, ConfiguredTargetKey>() {
        @Override
        public ConfiguredTargetKey apply(TargetAndConfiguration input) {
          return new ConfiguredTargetKey(input.getLabel(), input.getConfiguration());
        }
      };

  @Override
  public boolean equals(Object that) {
    if (this == that) {
      return true;
    }
    if (!(that instanceof TargetAndConfiguration)) {
      return false;
    }

    TargetAndConfiguration thatNode = (TargetAndConfiguration) that;
    return thatNode.target.getLabel().equals(this.target.getLabel()) &&
        thatNode.configuration == this.configuration;
  }

  @Override
  public int hashCode() {
    return Objects.hash(target.getLabel(), configuration);
  }

  @Override
  public String toString() {
    return target.getLabel() + " (" + configuration + ")";
  }

  public Target getTarget() {
    return target;
  }

  public Label getLabel() {
    return target.getLabel();
  }

  @Nullable
  public BuildConfiguration getConfiguration() {
    return configuration;
  }
}