io.opentelemetry.common.ReadableKeyValuePairs Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lightstep-opentelemetry-auto-exporter Show documentation

Lightstep OpenTelemetry Auto Exporter

The newest version!

/*
 * Copyright 2020, OpenTelemetry Authors
 *
 * Licensed 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 io.opentelemetry.common;

import javax.annotation.Nullable;

/**
 * A read-only container for String-keyed attributes.
 *
 * @param  The type of the values contained in this.
 */
public interface ReadableKeyValuePairs {
  /** The number of attributes contained in this. */
  int size();

  /** Whether there are any attributes contained in this. */
  boolean isEmpty();

  /** Iterates over all the key-value pairs of attributes contained by this instance. */
  void forEach(KeyValueConsumer consumer);

  /**
   * Returns the value of the given key, or null if the key does not exist.
   *
   * Currently may be implemented via a linear search, depending on implementation, so O(n)
   * performance in the worst case.
   */
  @Nullable
  V get(String key);

  /**
   * Used for iterating over the key-value pairs in a key-value pair container, such as {@link
   * Attributes} or {@link Labels}. The key is always a {@link String}.
   *
   * @param  The type of the values contained in the key-value pairs.
   */
  interface KeyValueConsumer {
    void consume(String key, V value);
  }
}