Interface DiagnosticReporter

All Known Implementing Classes:
AbstractDiagnosticReporter, CodeQualityReporter, ConsoleReporter, GenericIssueReporter, JsonReporter, JUnitReporter, SarifReporter, TSLintReporter
public interface DiagnosticReporter
Интерфейс для репортеров результатов анализа.

Репортеры формируют отчеты о найденных диагностиках в различных форматах (JSON, JUnit XML, консольный вывод и т.д.).

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    isMetricCalculationRequired()
    Признак того, что репортеру для формирования отчета необходимы метрики документов.
    String
    key()
    Получить ключ (идентификатор) репортера.
    void
    report(AnalysisInfo analysisInfo, Path outputDir)
    Сформировать отчет о результатах анализа.

  • Method Details

    • key

      String key()
      Получить ключ (идентификатор) репортера.
      Returns:
      Уникальный ключ репортера

    • report

      void report(AnalysisInfo analysisInfo, Path outputDir)
      Сформировать отчет о результатах анализа.
      Parameters:
      analysisInfo - Информация о результатах анализа
      outputDir - Директория для сохранения отчета

    • isMetricCalculationRequired

      default boolean isMetricCalculationRequired()
      Признак того, что репортеру для формирования отчета необходимы метрики документов.

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

      Returns:
      true, если репортеру нужны метрики документов, иначе false