Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.quality.consistency

public Class BibliographyConsistencyCheckResultGitHubActionsWriter

extends BibliographyConsistencyCheckResultWriter
Class Inheritance
Imports
java.io.IOException, .Writer, java.nio.file.Path, java.util.Optional, .Set, org.jabref.logic.importer.ParserResult, org.jabref.logic.util.GitHubActionsEscape, org.jabref.model.database.BibDatabaseMode, org.jabref.model.entry.BibEntry, .BibEntryTypesManager, org.jabref.model.entry.field.Field
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.quality.consistency.BibliographyConsistencyCheckResultWriter:
allReportedFieldsbibDatabaseModecolumnCountcolumnNamesentryTypesManagerisPorcelainOPTIONAL_FIELD_AT_ENTRY_TYPE_CELL_ENTRYREQUIRED_FIELD_AT_ENTRY_TYPE_CELL_ENTRYresultUNKNOWN_FIELD_AT_ENTRY_TYPE_CELL_ENTRYUNSET_FIELD_AT_ENTRY_TYPE_CELL_ENTRYwriter

Constructor Summary

AccessConstructor and Description
public
BibliographyConsistencyCheckResultGitHubActionsWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain, BibEntryTypesManager entryTypesManager, BibDatabaseMode bibDatabaseMode, ParserResult parserResult, Path inputFile)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements java.io.Closeable.close.

Closes this stream and releases any system resources associated with it.

private void
write(ParserResult.Range range, String citationKey, Field field, String message)

protected void
writeBibEntry(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields)

Implements abstract org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter.writeBibEntry.

Inherited from org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter:
getFindingsAsListwriteFindingswriteMapEntry

Field Detail

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

Constructor Detail

BibliographyConsistencyCheckResultGitHubActionsWriterback to summary
public BibliographyConsistencyCheckResultGitHubActionsWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain, BibEntryTypesManager entryTypesManager, BibDatabaseMode bibDatabaseMode, ParserResult parserResult, Path inputFile)

Method Detail

closeback to summary
public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
writeback to summary
private void write(ParserResult.Range range, String citationKey, Field field, String message) throws IOException
writeBibEntryback to summary
protected void writeBibEntry(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields) throws IOException

Implements abstract org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter.writeBibEntry.

Annotations
@Override