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

Go to download

package com.teamscale.index.metadata;

import java.util.Set;

import org.conqat.lib.commons.collections.Pair;

/**
 * Interface that defines common services for performing actions related to
 * {@link IFileMetadata} for various languages.
 */
public interface IFileMetadataHelper {

	/**
	 * Initializes and returns some empty metadata file.
	 */
	IFileMetadata createEmptyFileMetadata();

	/**
	 * Returns a collection of metadata field names.
	 */
	Set getMetadataFields();

	/**
	 * Sets the value of some metadata field
	 */
	void saveFieldAndValueIntoMetadata(IFileMetadata metadata, Pair fieldNameAndValue);
}