nl.topicus.jdbc.shaded.com.google.instrumentation.trace.StartSpanOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spanner-jdbc Show documentation
JDBC Driver for Google Cloud Spanner
There is a newer version: 1.1.6
/*
 * Copyright 2016, Google Inc.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in nl.topicus.jdbc.shaded.com.liance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.nl.topicus.jdbc.shaded.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 nl.topicus.jdbc.shaded.com.google.instrumentation.trace;

import nl.topicus.jdbc.shaded.com.google.nl.topicus.jdbc.shaded.com.on.base.Objects;
import java.util.Collections;
import java.util.List;
import nl.topicus.jdbc.shaded.javax.annotation.Nullable;

/**
 * A class that enables overriding the default values used when starting a {@link Span}. Allows
 * overriding the {@link Sampler sampler}, the parent links, and option to record all the events
 * even if the {@code Span} is not sampled.
 */
public final class StartSpanOptions {
  private Sampler sampler;
  private List parentLinks;
  private Boolean recordEvents;

  StartSpanOptions() {
    this.sampler = null;
    this.parentLinks = null;
    this.recordEvents = null;
  }

  /**
   * Returns the {@link Sampler} to be used, or {@code null} if default.
   *
   * @return the {@code Sampler} to be used, or {@code null} if default.
   */
  @Nullable
  public Sampler getSampler() {
    return sampler;
  }

  /**
   * Returns the parent links to be set for the {@link Span}.
   *
   * @return the parent links to be set for the {@code Span}.
   */
  public List getParentLinks() {
    // Return an unmodifiable list.
    return parentLinks == null
        ? Collections.emptyList()
        : Collections.unmodifiableList(parentLinks);
  }

  /**
   * Returns the record events option setting.
   *
   * @return the record events option setting.
   */
  @Nullable
  public Boolean getRecordEvents() {
    return recordEvents;
  }

  @Override
  public boolean equals(Object obj) {
    if (obj == this) {
      return true;
    }

    if (!(obj instanceof StartSpanOptions)) {
      return false;
    }

    StartSpanOptions that = (StartSpanOptions) obj;
    return Objects.equal(sampler, that.sampler)
        && Objects.equal(parentLinks, that.parentLinks)
        && Objects.equal(recordEvents, that.recordEvents);
  }

  @Override
  public int hashCode() {
    return Objects.hashCode(sampler, parentLinks, recordEvents);
  }

  void setSampler(@Nullable Sampler sampler) {
    this.sampler = sampler;
  }

  void setParentLinks(@Nullable List parentLinks) {
    this.parentLinks = parentLinks;
  }

  void setRecordEvents(@Nullable Boolean recordEvents) {
    this.recordEvents = recordEvents;
  }
}