org.avaje.metric.TimingMetricInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of avaje-metric-api Show documentation

The newest version!

package org.avaje.metric;

/**
 * Bean holding timing metric name and collection count.
 * 
 * This is simple data bean intended to be passed to a front end, converted to JSON etc.
 * 
 */
public class TimingMetricInfo {

  final String name;

  final int collectionCount;

  /**
   * Construct with metric name and collection count.
   */
  public TimingMetricInfo(String name, int collectionCount) {
    this.name = name;
    this.collectionCount = collectionCount;
  }

  /**
   * Return the metric name.
   */
  public String getName() {
    return name;
  }

  /**
   * Return the current collection count for this metric.
   * 
   * This is the number of remaining requests that will have timing collected.
   * 
   */
  public int getCollectionCount() {
    return collectionCount;
  }
}