helix-core/src/main/java/org/apache/helix/monitoring/metrics/model/RatioMetric.java

package org.apache.helix.monitoring.metrics.model;

/*
 * 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.
 */

import org.apache.helix.monitoring.mbeans.dynamicMBeans.DynamicMetric;
import org.apache.helix.monitoring.mbeans.dynamicMBeans.SimpleDynamicMetric;


/**
 * A gauge which defines the ratio of one value to another.
 */
public abstract class RatioMetric extends SimpleDynamicMetric<Double> implements Metric<Double> {
  /**
   * Instantiates a new Simple dynamic metric.
   *  @param metricName the metric name
   * @param metricObject the metric object
   */
  public RatioMetric(String metricName, double metricObject) {
    super(metricName, metricObject);
  }

  @Override
  public DynamicMetric getDynamicMetric() {
    return this;
  }

  @Override
  public String getMetricName() {
    return _metricName;
  }

  @Override
  public Double getLastEmittedMetricValue() {
    return getValue();
  }

  @Override
  public String toString() {
    return String.format("Metric name: %s, metric value: %f", getMetricName(), getValue());
  }
}