EmptyDistributedContext.java

/*
 * Copyright 2019, 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.distributedcontext;

import java.util.Collection;
import java.util.Collections;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;

/**
 * An immutable implementation of the {@link DistributedContext} that does not contain any entries.
 */
@Immutable
public class EmptyDistributedContext implements DistributedContext {
  private static final Collection<Entry> EMPTY_COLLECTION = Collections.emptyList();

  /**
   * Returns the single instance of the {@link EmptyDistributedContext} class.
   *
   * @return the single instance of the {@code EmptyDistributedContext} class.
   * @since 0.1.0
   */
  public static DistributedContext getInstance() {
    return INSTANCE;
  }

  private static final DistributedContext INSTANCE = new EmptyDistributedContext();

  @Override
  public Collection<Entry> getEntries() {
    return EMPTY_COLLECTION;
  }

  @Nullable
  @Override
  public EntryValue getEntryValue(EntryKey entryKey) {
    return null;
  }

  private EmptyDistributedContext() {}
}