Class BuildTimeReporter

java.lang.Object

org.revapi.maven.BuildTimeReporter

All Implemented Interfaces:

AutoCloseable, org.revapi.configuration.Configurable, org.revapi.Reporter

public final class BuildTimeReporter
extends Object
implements org.revapi.Reporter

Build-time reporter is a Reporter extension for Revapi that is used by the CheckMojo to output the found problems and also to provide the suggestions to the user how to ignore the problems if deemed ok.

Even though this is a normal Revapi extension, it doesn't use the normal configuration mechanisms provided by Revapi (i.e. it doesn't define a configuration schema and doesn't accept any configuration from the configuration in the analysis context during the initialize(AnalysisContext) method). Instead, it is configured through the AnalysisContext.getData(String). This is to make it easier to pass complex objects to the reporter and also to amplify the fact that this is no "normal" extension but is tightly bound to the CheckMojo and the Maven build.

Since:

0.1

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	BuildTimeReporter.SuggestionBuilderContext	The context that can be used by the BuildTimeReporter.SuggestionsBuilder to get information about the differences and the configured output options.
static interface	BuildTimeReporter.SuggestionsBuilder	A suggestion builder is an object that the BuildTimeReporter uses to render suggestions for ignoring the found problems.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BREAKING_CRITICALITY_KEY
static final String	OUTPUT_NON_IDENTIFYING_ATTACHMENTS
static final String	SUGGESTIONS_BUILDER_KEY

Constructor Summary

Constructors

Constructor	Description
BuildTimeReporter()

Method Summary

Modifier and Type	Method	Description
void	close()
String	getAllProblemsMessage()
String	getExtensionId()
String	getIgnoreSuggestion()
Reader	getJSONSchema()
boolean	hasBreakingProblems()
void	initialize(org.revapi.AnalysisContext context)
void	report(org.revapi.Report report)

Methods inherited from class java.lang.Object

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

Field Details

BREAKING_CRITICALITY_KEY

public static final String BREAKING_CRITICALITY_KEY

See Also:

• Constant Field Values

OUTPUT_NON_IDENTIFYING_ATTACHMENTS

public static final String OUTPUT_NON_IDENTIFYING_ATTACHMENTS

See Also:

• Constant Field Values

SUGGESTIONS_BUILDER_KEY

public static final String SUGGESTIONS_BUILDER_KEY

See Also:

• Constant Field Values

Constructor Details

BuildTimeReporter

public BuildTimeReporter()

Method Details

hasBreakingProblems

public boolean hasBreakingProblems()

getAllProblemsMessage

public String getAllProblemsMessage()

getIgnoreSuggestion

public String getIgnoreSuggestion()

getExtensionId

@Nullable
public String getExtensionId()

Specified by:

getExtensionId in interface org.revapi.configuration.Configurable

getJSONSchema

@Nullable
public Reader getJSONSchema()

Specified by:

getJSONSchema in interface org.revapi.configuration.Configurable

initialize

public void initialize(@Nonnull
 org.revapi.AnalysisContext context)

Specified by:

initialize in interface org.revapi.configuration.Configurable

report

public void report(@Nonnull
 org.revapi.Report report)

Specified by:

report in interface org.revapi.Reporter

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException