geode-core/src/main/java/org/apache/geode/internal/statistics/SimpleStatisticId.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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 org.apache.geode.internal.statistics;

import org.apache.geode.StatisticDescriptor;
import org.apache.geode.Statistics;

/**
 * Identifies a specific instance of a stat as defined by a StatisticDescriptor.
 * <p>
 * A StatisticsType contains any number of StatisticDescriptors. A StatisticsType may describe one
 * or more Statistics instances, while a StatisticDescriptor may describe one or more StatisticId
 * instances.
 *
 * @since GemFire 7.0
 */
public class SimpleStatisticId implements StatisticId {

  private final StatisticDescriptor descriptor;
  private final Statistics statistics;

  protected SimpleStatisticId(StatisticDescriptor descriptor, Statistics statistics) {
    this.descriptor = descriptor;
    this.statistics = statistics;
  }

  @Override
  public StatisticDescriptor getStatisticDescriptor() {
    return this.descriptor;
  }

  @Override
  public Statistics getStatistics() {
    return this.statistics;
  }

  /**
   * Object equality must be based on instance identity.
   */
  @Override
  public boolean equals(Object obj) {
    return super.equals(obj);
  }

  /**
   * Object equality must be based on instance identity.
   */
  @Override
  public int hashCode() {
    return super.hashCode();
  }
}