src/com/facebook/buck/rules/BuildRuleType.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.rules;

import com.google.common.base.Preconditions;

public final class BuildRuleType {
  // TODO(simons): Move each of these closer to the BuildRules they represent.
  public static BuildRuleType ANDROID_BINARY = new BuildRuleType("android_binary");
  public static BuildRuleType ANDROID_INSTRUMENTATION_APK = new BuildRuleType("android_instrumentation_apk");
  public static BuildRuleType ANDROID_LIBRARY = new BuildRuleType("android_library");
  public static BuildRuleType ANDROID_MANIFEST = new BuildRuleType("android_manifest");
  public static BuildRuleType ANDROID_RESOURCE = new BuildRuleType("android_resource");
  public static BuildRuleType APK_GENRULE = new BuildRuleType("apk_genrule");
  public static BuildRuleType EXPORT_FILE = new BuildRuleType("export_file");
  public static BuildRuleType GEN_AIDL = new BuildRuleType("gen_aidl");
  public static BuildRuleType GEN_PARCELABLE = new BuildRuleType("gen_parcelable");
  public static BuildRuleType GENRULE = new BuildRuleType("genrule");
  public static BuildRuleType JAVA_BINARY = new BuildRuleType("java_binary");
  public static BuildRuleType JAVA_LIBRARY = new BuildRuleType("java_library");
  public static BuildRuleType JAVA_TEST = new BuildRuleType("java_test");
  public static BuildRuleType KEYSTORE = new BuildRuleType("keystore");
  public static BuildRuleType NDK_LIBRARY = new BuildRuleType("ndk_library");
  public static BuildRuleType PREBUILT_JAR = new BuildRuleType("prebuilt_jar");
  public static BuildRuleType PREBUILT_NATIVE_LIBRARY = new BuildRuleType("prebuilt_native_library");
  public static BuildRuleType PROJECT_CONFIG = new BuildRuleType("project_config");
  public static BuildRuleType PYTHON_BINARY = new BuildRuleType("python_binary");
  public static BuildRuleType PYTHON_LIBRARY = new BuildRuleType("python_library");
  public static BuildRuleType ROBOLECTRIC_TEST = new BuildRuleType("robolectric_test");
  public static BuildRuleType SH_BINARY = new BuildRuleType("sh_binary");
  public static BuildRuleType SH_TEST = new BuildRuleType("sh_test");

  private final String name;
  private final boolean isTestRule;

  /**
   * @param name must match the name of a type of build rule used in a build file (eg. "genrule").
   */
  public BuildRuleType(String name)  {
    this.name = Preconditions.checkNotNull(name).toLowerCase();
    this.isTestRule = name.endsWith("_test");
  }

  /**
   * @return the name as displayed in a build file, such as "java_library"
   */
  public String getName() {
    return name;
  }

  public boolean isTestRule() {
    return isTestRule;
  }

  @Override
  public int hashCode() {
    return name.hashCode();
  }

  @Override
  public boolean equals(Object that) {
    if (that == null || !(that instanceof BuildRuleType)) {
      return false;
    }
    return getName().equals(((BuildRuleType) that).getName());
  }

  @Override
  public String toString() {
    return name;
  }
}