Class JsonReporter

java.lang.Object
com.github._1c_syntax.bsl.languageserver.reporters.JsonReporter
All Implemented Interfaces:
DiagnosticReporter
@Component public class JsonReporter extends Object implements DiagnosticReporter

  • Constructor Summary

    Constructors
    Constructor
    Description
    JsonReporter()
     

  • Method Summary

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

    Methods inherited from class Object

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

  • Constructor Details

    • JsonReporter

      public JsonReporter()

  • Method Details

    • key

      public String key()
      Description copied from interface: DiagnosticReporter
      Получить ключ (идентификатор) репортера.
      Specified by:
      key in interface DiagnosticReporter
      Returns:
      Уникальный ключ репортера

    • isMetricCalculationRequired

      public boolean isMetricCalculationRequired()
      Description copied from interface: DiagnosticReporter
      Признак того, что репортеру для формирования отчета необходимы метрики документов.

      Значение по умолчанию — false. Переопределяется в true только теми репортерами, которые действительно включают метрики в отчет (в файл или иной вывод). Это позволяет пропустить вычисление метрик, если ни один из активных репортеров их не использует.

      Specified by:
      isMetricCalculationRequired in interface DiagnosticReporter
      Returns:
      true, если репортеру нужны метрики документов, иначе false

    • beginReport

      public void beginReport(ReportContext context, Path outputDir)
      Description copied from interface: DiagnosticReporter
      Начать отчёт: открыть файл, записать заголовок.
      Specified by:
      beginReport in interface DiagnosticReporter
      Parameters:
      context - сведения об анализе
      outputDir - каталог для сохранения отчёта

    • accept

      public void accept(FileInfo fileInfo)
      Description copied from interface: DiagnosticReporter
      Записать результат одного файла.
      Specified by:
      accept in interface DiagnosticReporter
      Parameters:
      fileInfo - результаты анализа файла; после возврата из метода не сохраняется

    • endReport

      public void endReport()
      Description copied from interface: DiagnosticReporter
      Завершить отчёт: дописать концовку и зафиксировать файл.
      Specified by:
      endReport in interface DiagnosticReporter

    • abortReport

      public void abortReport()
      Description copied from interface: DiagnosticReporter
      Прервать отчёт: освободить ресурсы и не оставлять недописанный файл.

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

      Specified by:
      abortReport in interface DiagnosticReporter