com.teamscale.index.metadata.IFileMetadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamscale-commons Show documentation

Provides common DTOs for Teamscale

The newest version!

package com.teamscale.index.metadata;

import java.io.Serializable;

import org.conqat.lib.commons.collections.PairList;
import org.conqat.lib.commons.test.IndexValueClass;

/**
 * A unifying interface representing metadata for files of various languages.
 */
@IndexValueClass
public interface IFileMetadata extends Serializable {

	/**
	 * Returns all metric which are defined by the given metadata.
	 * 
	 * The first value is the metric name and the second value is the metric value.
	 * 

	 * All metrics which are returned here should be registered in {@literal FileMetadataConfiguration}.
	 * 
	 * Important: All partitions should always be returned, even if they have an empty
	 * value.
	 */
	PairList getMetrics();
}