com.newrelic.telemetry.Attributes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of telemetry-core Show documentation
Used to send telemetry data to New Relic
There is a newer version: 0.16.0
/*
 * Copyright 2019 New Relic Corporation. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package com.newrelic.telemetry;

import static java.util.Collections.unmodifiableMap;

import java.util.HashMap;
import java.util.Map;

/**
 * A collection of key-value pairs that can be used as the dimensional attributes for metrics.
 *
 * Only String keys are allowed. Acceptable values for attributes include Numbers, Strings, and
 * booleans.
 */
public class Attributes {
  private final Map rawAttributes = new HashMap<>();

  /** Creates an empty object */
  public Attributes() {}

  /**
   * @param original Creates a copy. Changes to the new copy will not affect the original and vice
   *     versa.
   */
  public Attributes(Attributes original) {
    rawAttributes.putAll(original.rawAttributes);
  }

  /**
   * Creates a copy. Changes to the new copy will not affect the original and vice versa.
   *
   * @return new instance holding current attributes
   */
  public Attributes copy() {
    return new Attributes(this);
  }

  /**
   * Merge attributes into current attributes
   *
   * @param incoming attributes to be merged
   * @return this
   */
  public Attributes putAll(Attributes incoming) {
    rawAttributes.putAll(incoming.rawAttributes);
    return this;
  }

  /**
   * Add a string-valued attribute.
   *
   * @param key to locate the value
   * @param value to be stored
   * @return this
   */
  public Attributes put(String key, String value) {
    rawAttributes.put(key, value);
    return this;
  }

  /**
   * Add a Number-valued attribute.
   *
   * @param key to locate the value
   * @param value to be stored
   * @return this
   */
  public Attributes put(String key, Number value) {
    rawAttributes.put(key, value);
    return this;
  }

  /**
   * Add a boolean-valued attribute.
   *
   * @param key to locate the value
   * @param value to be stored
   * @return this
   */
  public Attributes put(String key, boolean value) {
    rawAttributes.put(key, value);
    return this;
  }

  /**
   * Make a copy of these attributes.
   *
   * @return An unmodifiable copy of these attributes, as a Map.
   */
  public Map asMap() {
    return unmodifiableMap(new HashMap<>(rawAttributes));
  }

  /** @return true if there are no attributes in this Attributes instance */
  public boolean isEmpty() {
    return rawAttributes.isEmpty();
  }

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

    Attributes that = (Attributes) o;

    return rawAttributes != null
        ? rawAttributes.equals(that.rawAttributes)
        : that.rawAttributes == null;
  }

  @Override
  public int hashCode() {
    return rawAttributes != null ? rawAttributes.hashCode() : 0;
  }

  @Override
  public String toString() {
    return "Attributes{" + "rawAttributes=" + rawAttributes + '}';
  }
}