/*
 * Copyright 2013-2021 the original author or 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
 *
 *      https://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.springframework.cloud.sleuth.autoconfig.actuate;

import java.util.List;

import org.springframework.cloud.sleuth.exporter.FinishedSpan;

/**
 * Writes finished spans in a provided format.
 *
 * @author Marcin Grzejszczak
 * @since 3.1.0
 */
public interface FinishedSpanWriter<T> {

	/**
	 * Writes the spans in a given format to String.
	 * @param format format in which spans should be stored
	 * @param spans spans to store
	 * @return string representation of spans or {@code null} if {@link TextOutputFormat}
	 * is not supported.
	 */
	T write(TextOutputFormat format, List<FinishedSpan> spans);

}
