com.newrelic.telemetry.metrics.Count Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 New Relic Corporation. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package com.newrelic.telemetry.metrics;

import com.newrelic.telemetry.Attributes;
import com.newrelic.telemetry.util.Utils;
import java.util.Map;

/**
 * A {@link Metric} that represents a single signed, floating-point quantity measured over a period
 * of time.
 *
 * Important: Values are not validated on construction, and this class's methods do not
 * throw.
 */
public final class Count implements Metric {

  private final String name;
  private final double value;
  private final long startTimeMs;
  private final long endTimeMs;
  private final Map attributes;

  /**
   * Create a new Count instance.
   *
   * @param name The name of this count instance.
   * @param value The value for this count instance.
   * @param startTimeMs The start time of the interval over which the count was measured. This is in
   *     milliseconds since epoch.
   * @param endTimeMs The end time of the interval over which the count was measured. This is in
   *     milliseconds since epoch.
   * @param attributes Any additional attributes associated with this count.
   */
  public Count(String name, double value, long startTimeMs, long endTimeMs, Attributes attributes) {
    this.name = Utils.verifyNonNull(name);
    this.value = value;
    this.startTimeMs = startTimeMs;
    this.endTimeMs = endTimeMs;
    this.attributes = Utils.verifyNonNull(attributes).asMap();
  }

  /** @return The name for this Count metric. */
  public String getName() {
    return name;
  }

  /** @return Dimensional attributes, as key-value pairs, associated with this Count. */
  public Map getAttributes() {
    return attributes;
  }

  /**
   * @return The value, which should be a positive number, representing the Count for the provided
   *     interval.
   */
  public double getValue() {
    return value;
  }

  /**
   * @return The start time of the interval over which this Count was recorded, in milliseconds
   *     since epoch.
   */
  public long getStartTimeMs() {
    return startTimeMs;
  }

  /**
   * @return The end time of the interval over which this Count was recorded, in milliseconds since
   *     epoch.
   */
  public long getEndTimeMs() {
    return endTimeMs;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;

    Count count = (Count) o;

    if (Double.compare(count.getValue(), getValue()) != 0) return false;
    if (getStartTimeMs() != count.getStartTimeMs()) return false;
    if (getEndTimeMs() != count.getEndTimeMs()) return false;
    if (getName() != null ? !getName().equals(count.getName()) : count.getName() != null)
      return false;
    return getAttributes() != null
        ? getAttributes().equals(count.getAttributes())
        : count.getAttributes() == null;
  }

  @Override
  public int hashCode() {
    int result;
    long temp;
    result = getName() != null ? getName().hashCode() : 0;
    temp = Double.doubleToLongBits(getValue());
    result = 31 * result + (int) (temp ^ (temp >>> 32));
    result = 31 * result + (int) (getStartTimeMs() ^ (getStartTimeMs() >>> 32));
    result = 31 * result + (int) (getEndTimeMs() ^ (getEndTimeMs() >>> 32));
    result = 31 * result + (getAttributes() != null ? getAttributes().hashCode() : 0);
    return result;
  }

  @Override
  public String toString() {
    return "Count{"
        + "name='"
        + name
        + '\''
        + ", value="
        + value
        + ", startTimeMs="
        + startTimeMs
        + ", endTimeMs="
        + endTimeMs
        + ", attributes="
        + attributes
        + '}';
  }
}