net.neoforged.problems

Interface ProblemReporter

All Known Implementing Classes:

FileProblemReporter

public interface ProblemReporter

Report problems from plugins.

Inspired by https://docs.gradle.org/8.14/javadoc/org/gradle/api/problems/ProblemReporter.html

Field Summary

Fields

Modifier and Type	Field and Description
static ProblemReporter	NOOP

Method Summary

Modifier and Type	Method and Description
void	report(Problem problem)
default void	report(ProblemId problemId, ProblemSeverity severity, ProblemLocation location, java.lang.String contextualLabel)
default void	report(ProblemId problemId, ProblemSeverity severity, java.lang.String contextualLabel) Reports a location independent problem.
default void	tryMergeFromFile(java.nio.file.Path reportFile) Loads problems from the given report file (see FileProblemReporter) and add them to this reporter.
default void	tryMergeFromFile(java.nio.file.Path reportFile, java.util.function.Predicate<Problem> filter) Loads problems from the given report file (see FileProblemReporter) and add any that pass the given filter to this reporter.

Field Detail

NOOP

static final ProblemReporter NOOP

Method Detail

report

default void report(ProblemId problemId,
                    ProblemSeverity severity,
                    ProblemLocation location,
                    java.lang.String contextualLabel)

report

default void report(ProblemId problemId,
                    ProblemSeverity severity,
                    java.lang.String contextualLabel)

Reports a location independent problem.

report

void report(Problem problem)

tryMergeFromFile

default void tryMergeFromFile(java.nio.file.Path reportFile)
                       throws java.io.IOException

Loads problems from the given report file (see FileProblemReporter) and add them to this reporter.

Throws:

java.io.IOException

tryMergeFromFile

default void tryMergeFromFile(java.nio.file.Path reportFile,
                              java.util.function.Predicate<Problem> filter)
                       throws java.io.IOException

Loads problems from the given report file (see FileProblemReporter) and add any that pass the given filter to this reporter. If the given file is missing, nothing happens.

Throws:

java.io.IOException