Class SarifReporter

java.lang.Object

com.github._1c_syntax.bsl.languageserver.reporters.AbstractDiagnosticReporter

com.github._1c_syntax.bsl.languageserver.reporters.SarifReporter

All Implemented Interfaces:

DiagnosticReporter

@Component
public class SarifReporter
extends AbstractDiagnosticReporter

Репортер в формат SARIF.

See Also:

• SARIF specification.

Field Summary

Fields inherited from class AbstractDiagnosticReporter

diagnosticInfos, serverContextProvider

Constructor Summary

Constructors

Constructor	Description
SarifReporter(ServerContextProvider serverContextProvider, DiagnosticInfos diagnosticInfos, ServerInfo serverInfo, LanguageServerConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	abortReport()	Прервать отчёт: освободить ресурсы и не оставлять недописанный файл.
void	accept(FileInfo fileInfo)	Записать результат одного файла.
void	beginReport(ReportContext context, Path outputDir)	Начать отчёт: открыть файл, записать заголовок.
void	endReport()	Завершить отчёт: дописать концовку и зафиксировать файл.
String	key()	Получить ключ (идентификатор) репортера.

Methods inherited from class AbstractDiagnosticReporter

getDiagnosticInfosByCode

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface DiagnosticReporter

isMetricCalculationRequired

Constructor Details

SarifReporter

public SarifReporter(ServerContextProvider serverContextProvider,
 DiagnosticInfos diagnosticInfos,
 ServerInfo serverInfo,
 LanguageServerConfiguration configuration)

Method Details

key

public String key()

Description copied from interface: DiagnosticReporter

Получить ключ (идентификатор) репортера.

Returns:

Уникальный ключ репортера

beginReport

public void beginReport(ReportContext context,
 Path outputDir)

Description copied from interface: DiagnosticReporter

Начать отчёт: открыть файл, записать заголовок.

Parameters:

context - сведения об анализе

outputDir - каталог для сохранения отчёта

accept

public void accept(FileInfo fileInfo)

Description copied from interface: DiagnosticReporter

Записать результат одного файла.

Parameters:

fileInfo - результаты анализа файла; после возврата из метода не сохраняется

endReport

public void endReport()

Description copied from interface: DiagnosticReporter

Завершить отчёт: дописать концовку и зафиксировать файл.

abortReport

public void abortReport()

Description copied from interface: DiagnosticReporter

Прервать отчёт: освободить ресурсы и не оставлять недописанный файл.

Вызывается на пути обработки ошибки, поэтому исключений не бросает. Реализация по умолчанию ничего не делает — она подходит репортёрам, которым нечего откатывать.