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

public Class IntegrityCheckResultGitHubActionsWriter

extends IntegrityCheckResultWriter
Class Inheritance
Imports
java.io.IOException, .Writer, java.nio.file.Path, java.util.List, org.jabref.logic.importer.ParserResult, org.jabref.logic.util.GitHubActionsEscape, org.jabref.model.entry.field.Field, .InternalField
Outputs the findings in the GitHub Actions workflow command format (::error file=...,line=...,col=...::message), so that findings show up as annotations on pull requests when jabkit runs inside a GitHub Actions workflow.

Field Summary

Modifier and TypeField and Description
private final Path
inputFile

private final ParserResult
parserResult

Inherited from org.jabref.logic.integrity.IntegrityCheckResultWriter:
messageswriter

Constructor Summary

AccessConstructor and Description
public
IntegrityCheckResultGitHubActionsWriter(Writer writer, List<IntegrityMessage> messages, ParserResult parserResult, Path inputFile)

Method Summary

Modifier and TypeMethod and Description
public void
writeFindings()

Implements abstract org.jabref.logic.integrity.IntegrityCheckResultWriter.writeFindings.

Inherited from org.jabref.logic.integrity.IntegrityCheckResultWriter:
close

Field Detail

inputFileback to summary
private final Path inputFile
parserResultback to summary
private final ParserResult parserResult

Constructor Detail

IntegrityCheckResultGitHubActionsWriterback to summary
public IntegrityCheckResultGitHubActionsWriter(Writer writer, List<IntegrityMessage> messages, ParserResult parserResult, Path inputFile)

Method Detail

writeFindingsback to summary
public void writeFindings() throws IOException

Implements abstract org.jabref.logic.integrity.IntegrityCheckResultWriter.writeFindings.

Annotations
@Override