src/main/java/com/google/devtools/build/lib/packages/SkylarkProviderIdentifier.java

// Copyright 2014 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.packages;

import com.google.devtools.build.lib.util.Preconditions;
import java.util.Objects;
import javax.annotation.Nullable;

/**
 * A wrapper around Skylark provider identifier,
 * representing either a declared provider ({@see SkylarkClassObjectConstructor})
 * or a "legacy" string identifier.
 */
public final class SkylarkProviderIdentifier {

  @Nullable
  private final String legacyId;
  @Nullable
  private final SkylarkClassObjectConstructor.Key key;

  /**
   * Creates an id for a declared provider with a given key ({@see SkylarkClassObjectConstructor}).
   */
  public static SkylarkProviderIdentifier forKey(SkylarkClassObjectConstructor.Key key) {
    return new SkylarkProviderIdentifier(key);
  }

  /**
   * Creates an id for a provider with a given name.
   */
  public static SkylarkProviderIdentifier forLegacy(String legacyId) {
    return new SkylarkProviderIdentifier(legacyId);
  }

  private SkylarkProviderIdentifier(String legacyId) {
    this.legacyId = legacyId;
    this.key = null;
  }

  private SkylarkProviderIdentifier(SkylarkClassObjectConstructor.Key key) {
    this.legacyId = null;
    this.key = key;
  }

  /**
   * Returns true if this {@link SkylarkProviderIdentifier} identifies
   * a legacy provider (with a string name).
   */
  public boolean isLegacy() {
    return legacyId != null;
  }

  /**
   * Returns a string identifying the provider (only for legacy providers).
   */
  public String getLegacyId() {
    Preconditions.checkState(isLegacy(), "Check isLegacy() first");
    return legacyId;
  }

  /**
   * Returns a key identifying the declared provider (only for non-legacy providers).
   */
  public SkylarkClassObjectConstructor.Key getKey() {
    Preconditions.checkState(!isLegacy(), "Check !isLegacy() first");
    return key;
  }

  @Override
  public String toString() {
    if (isLegacy()) {
      return legacyId;
    }
    return key.getExportedName();
  }

  @Override
  public int hashCode() {
    return Objects.hash(legacyId, key);
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj) {
      return true;
    }
    if (!(obj instanceof SkylarkProviderIdentifier)) {
      return false;
    }
    SkylarkProviderIdentifier other = (SkylarkProviderIdentifier) obj;
    return Objects.equals(legacyId, other.legacyId)
        && Objects.equals(key, other.key);
  }
}