com.google.firebase.projectmanagement.AndroidAppMetadata Maven / Gradle / Ivy

Go to download
/* Copyright 2018 Google 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.google.firebase.projectmanagement;

import com.google.common.base.MoreObjects;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import com.google.firebase.internal.Nullable;

/**
 * Contains detailed information about an Android App. Instances of this class are immutable.
 */
public class AndroidAppMetadata {

  private final String name;
  private final String appId;
  private final String displayName;
  private final String projectId;
  private final String packageName;

  AndroidAppMetadata(
      String name, String appId, String displayName, String projectId, String packageName) {
    this.name = Preconditions.checkNotNull(name, "Null name");
    this.appId = Preconditions.checkNotNull(appId, "Null appId");
    this.displayName = displayName;
    this.projectId = Preconditions.checkNotNull(projectId, "Null projectId");
    this.packageName = Preconditions.checkNotNull(packageName, "Null packageName");
  }

  /**
   * Returns the fully qualified resource name of this Android App.
   */
  String getName() {
    return name;
  }

  /**
   * Returns the globally unique, Firebase-assigned identifier of this Android App. This ID is
   * unique even across Apps of different platforms, such as iOS Apps.
   */
  public String getAppId() {
    return appId;
  }

  /**
   * Returns the user-assigned display name of this Android App. Returns {@code null} if it has
   * never been set.
   */
  @Nullable
  public String getDisplayName() {
    return displayName;
  }

  /**
   * Returns the permanent, globally unique, user-assigned ID of the parent Project for this Android
   * App.
   */
  public String getProjectId() {
    return projectId;
  }

  /**
   * Returns the canonical package name of this Android app as it would appear in Play store.
   */
  public String getPackageName() {
    return packageName;
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper("AndroidAppMetadata")
        .add("name", name)
        .add("appId", appId)
        .add("displayName", displayName)
        .add("projectId", projectId)
        .add("packageName", packageName)
        .toString();
  }

  @Override
  public boolean equals(Object o) {
    if (o == this) {
      return true;
    }
    if (o instanceof AndroidAppMetadata) {
      AndroidAppMetadata that = (AndroidAppMetadata) o;
      return Objects.equal(this.name, that.name)
          && Objects.equal(this.appId, that.appId)
          && Objects.equal(this.displayName, that.displayName)
          && Objects.equal(this.projectId, that.projectId)
          && Objects.equal(this.packageName, that.packageName);
    }
    return false;
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(name, appId, displayName, projectId, packageName);
  }

}