Top Description Methods
org.jabref.logic.texparser

public Interface LatexParser

Known Direct Implementers
org.jabref.logic.texparser.DefaultLatexParser
Imports
java.nio.file.Path, java.util.List, .Optional, org.jabref.model.texparser.LatexParserResult, .LatexParserResults

Parses a LaTeX file

Method Summary

Modifier and TypeMethod and Description
public LatexParserResult

Returns:

a LatexParserResult, where Path is "" and lineNumber is 1
parse
(String
String that contains a citation
citeString
)

For testing purposes.

public Optional<LatexParserResult>

Returns:

Optional LatexParserResult, which contains all data related to the bibliographic entries, or empty if the file does not exist
parse
(Path
Path to a LaTeX file
latexFile
)

Parse a single LaTeX file.

public LatexParserResults

Returns:

a LatexParserResults, which contains all data related to the bibliographic entries
parse
(List<Path>
List of Path objects linked to a LaTeX file
latexFiles
)

Parse a list of LaTeX files.

Method Detail

parseback to summary
public LatexParserResult parse(String citeString)

For testing purposes.

Parameters
citeString:String

String that contains a citation

Returns:LatexParserResult

a LatexParserResult, where Path is "" and lineNumber is 1

parseback to summary
public Optional<LatexParserResult> parse(Path latexFile)

Parse a single LaTeX file.

Parameters
latexFile:Path

Path to a LaTeX file

Returns:Optional<LatexParserResult>

Optional LatexParserResult, which contains all data related to the bibliographic entries, or empty if the file does not exist

parseback to summary
public LatexParserResults parse(List<Path> latexFiles)

Parse a list of LaTeX files.

Parameters
latexFiles:List<Path>

List of Path objects linked to a LaTeX file

Returns:LatexParserResults

a LatexParserResults, which contains all data related to the bibliographic entries