src/com/facebook/buck/command/Module.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.command.Project.SourceFolder;
import com.facebook.buck.model.BuildTarget;
import com.facebook.buck.rules.BuildRule;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;

import java.util.Comparator;
import java.util.List;
import java.util.SortedSet;

@JsonInclude(Include.NON_NULL)
@VisibleForTesting
final class Module implements Comparable<Module> {

  private static Comparator<SourceFolder> ALPHABETIZER = new Comparator<SourceFolder>() {

    @Override
    public int compare(SourceFolder a, SourceFolder b) {
      return a.getUrl().compareTo(b.getUrl());
    }

  };

  // In IntelliJ, options in an .iml file that correspond to file paths should be relative to the
  // location of the .iml file itself.
  final BuildRule srcRule;
  final BuildTarget target;  // For error reporting

  /**
   * Let intellij generate the gen directory to specific path.
   */
  @JsonProperty String moduleGenPath;

  @JsonProperty String name;
  @JsonProperty String pathToImlFile;
  @JsonProperty List<SourceFolder> sourceFolders = Lists.newArrayList();

  /**
   * &lt;excludeFolder> elements must be sorted alphabetically in an .iml file.
   */
  @JsonProperty SortedSet<SourceFolder> excludeFolders = Sets.newTreeSet(ALPHABETIZER);
  @JsonProperty List<DependentModule> dependencies;

  // ANDROID_BINARY / ANDROID_LIBRARY
  @JsonProperty Boolean hasAndroidFacet;
  @JsonProperty Boolean isAndroidLibraryProject;
  @JsonProperty String proguardConfigPath;
  @JsonProperty String resFolder;
  @JsonProperty String keystorePath;
  @JsonProperty String androidManifest;
  @JsonProperty String nativeLibs;
  @JsonProperty Boolean isIntelliJPlugin;

  // Annotation processing
  @JsonProperty String annotationGenPath;
  @JsonProperty Boolean annotationGenIsForTest;

  Module(BuildRule srcRule, BuildTarget target) {
    this.srcRule = srcRule;
    this.target = Preconditions.checkNotNull(target);
  }

  String getModuleDirectoryPathWithSlash() {
    int lastSlashIndex = pathToImlFile.lastIndexOf('/');
    if (lastSlashIndex < 0) {
      return "";
    } else {
      return pathToImlFile.substring(0, lastSlashIndex + 1);
    }
  }

  boolean isAndroidModule() {
    return hasAndroidFacet != null && hasAndroidFacet.booleanValue();
  }

  boolean isAndroidLibrary() {
    return isAndroidLibraryProject != null && isAndroidLibraryProject.booleanValue();
  }

  boolean isIntelliJPlugin() {
    return isIntelliJPlugin != null && isIntelliJPlugin.booleanValue();
  }

  @Override
  public int compareTo(Module module) {
    return this.target.getFullyQualifiedName().compareTo(module.target.getFullyQualifiedName());
  }
}