com.google.appengine.api.capabilities.Capability Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2021 Google LLC
 *
 * 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
 *
 *     https://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.appengine.api.capabilities;

import java.util.Objects;

/**
 * A capability represents a particular feature or set of features
 * available on the App Engine platform.
 *
 * To check the availability of a particular capability, use the
 * {@link CapabilitiesService} API.
 *
 *
 */
public class Capability {
  /**
   * Availability of BlobstoreService.
   *
   * @deprecated This service will always be reported as being available.
   */
  @Deprecated
  public static final Capability BLOBSTORE = new Capability("blobstore");

  /**
   * Availability of the datastore.
   *
   * @deprecated This service will always be reported as being available. If
   */
  @Deprecated
  public static final Capability DATASTORE = new Capability("datastore_v3");

  /**
   * Availability of datastore writes.
   */
  public static final Capability DATASTORE_WRITE = new Capability("datastore_v3", "write");
  /**
   * Availability of the ImagesService.
   */
  public static final Capability IMAGES = new Capability("images");
  /**
   * Availability of theMailService.
   */
  public static final Capability MAIL = new Capability("mail");
   /**
   * Availability of the ProspectiveSearchService.
   */
  public static final Capability PROSPECTIVE_SEARCH = new Capability("matcher");
  /**
   * Availability ofMemcacheService.
   */
  public static final Capability MEMCACHE = new Capability("memcache");
  /**
   * Availability of TaskQueueService.
   */
  public static final Capability TASKQUEUE = new Capability("taskqueue");
  /**
   * Availability of the URLFetchService.
   */
  public static final Capability URL_FETCH = new Capability("urlfetch");
  /**
   * Availability of the XMPPService.
   */
  public static final Capability XMPP = new Capability("xmpp");

  private final String packageName;
  private final String name;

  /**
   *
   * Creates a new instance of a Capability.
   *
   * @param packageName name of the package associated with this capability.
   *
   */
  public Capability(String packageName) {
    this(packageName, "*");
  }

  /**
   * Creates a new instance of a Capability.
   *
   * @param packageName name of the package associated with this capability.
   * @param name name of the capability.
   */
  public Capability(String packageName, String name) {
    if (packageName == null || name == null) {
      throw new NullPointerException();
    }
    this.packageName = packageName;
    this.name = name;
  }

  /**
   * Returns the package name associated with this capability.
   *
   * @return the package name associated with this capability.
   */
  public String getPackageName() {
    return packageName;
  }

  /**
   * Returns the name associated with this capability.
   *
   * @return the name associated with this capability.
   */
  public String getName() {
    return name;
  }

  @Override
  public String toString() {
    return "Capability(" + packageName + ", " + name + ")";
  }

  @Override
  public boolean equals(Object x) {
    if (x instanceof Capability) {
      Capability that = (Capability) x;
      return this.getPackageName().equals(that.getPackageName())
          && this.getName().equals(that.getName());
    } else {
      return false;
    }
  }

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