Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.crawler

public Class StudyYamlParser

extends Object
Class Inheritance
Imports
java.io.IOException, java.nio.file.Files, .Path, java.util.Map, org.jabref.model.study.Study, org.slf4j.Logger, .LoggerFactory, tools.jackson.core.type.TypeReference, tools.jackson.databind.ObjectMapper, tools.jackson.dataformat.yaml.YAMLFactory, .YAMLMapper, .YAMLWriteFeature

Example use: new StudyYamlParser().parseStudyYamlFile(studyDefinitionFile);

Field Summary

Modifier and TypeField and Description
private static final Logger

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public Study
parseStudyYamlFile(Path studyYamlFile)

Parses the given yaml study definition file into a study instance

public void
writeStudyYamlFile(Study study, Path studyYamlFile)

Writes the given study instance into a yaml file to the given path

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

LOGGERback to summary
private static final Logger LOGGER

Constructor Detail

StudyYamlParserback to summary
public StudyYamlParser()

Method Detail

parseStudyYamlFileback to summary
public Study parseStudyYamlFile(Path studyYamlFile) throws IOException

Parses the given yaml study definition file into a study instance

writeStudyYamlFileback to summary
public void writeStudyYamlFile(Study study, Path studyYamlFile) throws IOException

Writes the given study instance into a yaml file to the given path