src/com/facebook/buck/command/DependentModule.java

/*
 * 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.command;

import com.facebook.buck.model.BuildTarget;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;

import javax.annotation.Nullable;

@JsonInclude(Include.NON_NULL)
class DependentModule {

  private static final String LIBRARY_DEPENDENCY_TYPE = "library";
  private static final String MODULE_DEPENDENCY_TYPE = "module";

  // The BuildTarget which this DependentModule represent. For example
  // given the target:
  // java_library(name = "bar", deps = [ "//third_party/guava" ])
  // The DependentModule's target would be ":bar"
  @Nullable
  private final BuildTarget target;

  @JsonProperty
  private final String type;

  @JsonProperty
  String scope;

  @JsonProperty
  private String name;

  @JsonProperty
  private String moduleName;

  @JsonProperty
  private Boolean forTests;

  /**
   * Set if {@link #type} is {@code jdk}.
   */
  @JsonProperty
  @Nullable
  private String jdkName;

  /**
   * Set if {@link #type} is {@code jdk}.
   */
  @JsonProperty
  @Nullable
  private String jdkType;

  private DependentModule(String type, @Nullable BuildTarget target) {
    this.type = Preconditions.checkNotNull(type);
    this.target = target;
  }

  /**
   * Used for error reporting.
   *
   * @return the target that declared this module or null.
   */
  public String getTargetName() {
    if (target == null) {
      return null;
    }
    return target.getFullyQualifiedName();
  }

  boolean isLibrary() {
    return LIBRARY_DEPENDENCY_TYPE.equals(type);
  }

  boolean isModule() {
    return MODULE_DEPENDENCY_TYPE.equals(type);
  }

  String getLibraryName() {
    Preconditions.checkState(isLibrary());
    return name;
  }

  String getModuleName() {
    Preconditions.checkState(isModule());
    return moduleName;
  }

  static DependentModule newLibrary(BuildTarget owningTarget, String libraryName) {
    DependentModule module = new DependentModule(LIBRARY_DEPENDENCY_TYPE, owningTarget);
    module.name = libraryName;
    return module;
  }

  static DependentModule newModule(BuildTarget owningTarget, String moduleName) {
    DependentModule module = new DependentModule(MODULE_DEPENDENCY_TYPE, owningTarget);
    module.moduleName = moduleName;
    return module;
  }

  static DependentModule newSourceFolder() {
    return new DependentModule("sourceFolder", null);
  }

  static DependentModule newInheritedJdk() {
    return new DependentModule("inheritedJdk", null);
  }

  static DependentModule newStandardJdk() {
    DependentModule dependentModule = new DependentModule("jdk", null);
    dependentModule.jdkName = "1.7";
    dependentModule.jdkType = "JavaSDK";
    return dependentModule;
  }

  static DependentModule newIntelliJPluginJdk() {
    DependentModule dependentModule = new DependentModule("jdk", null);
    // TODO(mbolin): Find the appropriate jdkName for the user's machine.
    // "IDEA IC-117.798" is the one used on my machine for IntelliJ Community Edition 11.1.3.
    // It seems as though we need to find the IntelliJ executable on the user's machine and ask
    // what version it is, which is probably a path to madness. Instead, a user should probably
    // define a ~/.buckconfig or something that contains this information.
    dependentModule.jdkName = "IDEA IC-117.798";
    dependentModule.jdkType = "IDEA JDK";
    return dependentModule;
  }

  @Override
  public boolean equals(Object obj) {
    if (!(obj instanceof DependentModule)) {
      return false;
    }
    DependentModule that = (DependentModule)obj;
    return Objects.equal(this.target, that.target)
        && Objects.equal(this.type, that.type)
        && Objects.equal(this.scope, that.scope)
        && Objects.equal(this.name, that.name)
        && Objects.equal(this.moduleName, that.moduleName)
        && Objects.equal(this.forTests, that.forTests)
        && Objects.equal(this.jdkName, that.jdkName)
        && Objects.equal(this.jdkType, that.jdkType);
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(target, type, scope, name, moduleName, forTests, jdkName, jdkType);
  }

  // This is helpful in the event of a unit test failure.
  @Override
  public String toString() {
    return Objects.toStringHelper(DependentModule.class)
        .add("target", target)
        .add("type", type)
        .add("scope", scope)
        .add("name", name)
        .add("moduleName", moduleName)
        .add("forTests", forTests)
        .add("jdkName", jdkName)
        .add("jdkType", jdkType)
        .toString();
  }
}