/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.accumulo.trace.instrument;

import java.util.Map;

/**
 * @deprecated only used for ensuring backwards compatibility
 */
@Deprecated
public interface CloudtraceSpan {
  static final long ROOT_SPAN_ID = 0;

  /** Begin gathering timing information */
  void start();

  /** The block has completed, stop the clock */
  void stop();

  /** Get the start time, in milliseconds */
  long getStartTimeMillis();

  /** Get the stop time, in milliseconds */
  long getStopTimeMillis();

  /** Return the total amount of time elapsed since start was called, if running, or difference between stop and start */
  long accumulatedMillis();

  /** Has the span been started and not yet stopped? */
  boolean running();

  /** Return a textual description of this span */
  String description();

  /** A pseudo-unique (random) number assigned to this span instance */
  long spanId();

  /** The parent span: returns null if this is the root span */
  Span parent();

  /** A pseudo-unique (random) number assigned to the trace associated with this span */
  long traceId();

  /** Create a child span of this span with the given description */
  Span child(String description);

  @Override
  String toString();

  /** Return the pseudo-unique (random) number of the parent span, returns ROOT_SPAN_ID if this is the root span */
  long parentId();

  /** Add data associated with this span */
  void data(String key, String value);

  /** Get data associated with this span (read only) */
  Map<String,String> getData();
}
