A B C D E F G H I J N O P R S U V X

A

AbstractSuggestionsBuilder - Class in org.revapi.maven

A base class to BuildTimeReporter.SuggestionsBuilders that abstracts the walking of the differences and lets the subclasses only implement simple methods to output the suggestions in the given format.

AbstractSuggestionsBuilder() - Constructor for class org.revapi.maven.AbstractSuggestionsBuilder

alwaysCheckForReleaseVersion - Variable in class org.revapi.maven.ReportMojo

If true (the default) revapi will always download the information about the latest version from the remote repositories (instead of using locally cached info).

analysisConfiguration - Variable in class org.revapi.maven.ReportMojo

The JSON or XML configuration of various analysis options.

analysisConfigurationFiles - Variable in class org.revapi.maven.ReportMojo

The list of files containing the configuration of various analysis options.

Analyzer - Class in org.revapi.maven

ApiBreakageHintingReporter - Class in org.revapi.maven

ApiBreakageHintingReporter() - Constructor for class org.revapi.maven.ApiBreakageHintingReporter

ApiChangeLevel - Enum in org.revapi.maven

appendDifferenceField(StringBuilder, String, String) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

appendDifferenceField(StringBuilder, String, String) - Method in class org.revapi.maven.JsonSuggestionsBuilder

appendDifferenceField(StringBuilder, String, String) - Method in class org.revapi.maven.XmlSuggestionsBuilder

appendDifferenceFieldSeparator(StringBuilder) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

appendDifferenceFieldSeparator(StringBuilder) - Method in class org.revapi.maven.JsonSuggestionsBuilder

appendDifferenceFieldSeparator(StringBuilder) - Method in class org.revapi.maven.XmlSuggestionsBuilder

asDifferenceSeverity() - Method in enum org.revapi.maven.FailSeverity

B

BREAKING_CRITICALITY_KEY - Static variable in class org.revapi.maven.BuildTimeReporter

build(List<Report>, BuildTimeReporter.SuggestionBuilderContext) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

build(List<Report>, BuildTimeReporter.SuggestionBuilderContext) - Method in interface org.revapi.maven.BuildTimeReporter.SuggestionsBuilder

BuildTimeReporter - Class in org.revapi.maven

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.

BuildTimeReporter() - Constructor for class org.revapi.maven.BuildTimeReporter

BuildTimeReporter.SuggestionBuilderContext - Class in org.revapi.maven

The context that can be used by the BuildTimeReporter.SuggestionsBuilder to get information about the differences and the configured output options.

BuildTimeReporter.SuggestionsBuilder - Interface in org.revapi.maven

A suggestion builder is an object that the BuildTimeReporter uses to render suggestions for ignoring the found problems.

C

canGenerateReport() - Method in class org.revapi.maven.ReportAggregateMojo

canGenerateReport() - Method in class org.revapi.maven.ReportMojo

checkDependencies - Variable in class org.revapi.maven.ReportMojo

Whether to include the dependencies in the API checks.

CheckForkMojo - Class in org.revapi.maven

CheckForkMojo() - Constructor for class org.revapi.maven.CheckForkMojo

CheckMojo - Class in org.revapi.maven

Runs the API check of old and new artifacts using the specified configuration of extensions declared as dependencies of the plugin.

CheckMojo() - Constructor for class org.revapi.maven.CheckMojo

close() - Method in class org.revapi.maven.ApiBreakageHintingReporter

close() - Method in class org.revapi.maven.BuildTimeReporter

close() - Method in class org.revapi.maven.ReportTimeReporter

ConfigurationFile - Class in org.revapi.maven

A complex type for capturing the "analysisConfigurationFiles" elements.

ConfigurationFile() - Constructor for class org.revapi.maven.ConfigurationFile

ConvertToXmlConfigMojo - Class in org.revapi.maven

This is a helper goal to convert the old JSON Revapi configuration inside the POM files into the new XML based format.

ConvertToXmlConfigMojo() - Constructor for class org.revapi.maven.ConvertToXmlConfigMojo

ConvertToXmlConfigMojo.SilentReporter - Class in org.revapi.maven

D

disallowedExtensions - Variable in class org.revapi.maven.ReportMojo

A comma-separated list of extensions (fully-qualified class names thereof) that are not taken into account during API analysis.

E

endDifference(StringBuilder) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

endDifference(StringBuilder) - Method in class org.revapi.maven.JsonSuggestionsBuilder

endDifference(StringBuilder) - Method in class org.revapi.maven.XmlSuggestionsBuilder

endOptionalAttachmentsInComment(StringBuilder) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

endOptionalAttachmentsInComment(StringBuilder) - Method in class org.revapi.maven.JsonSuggestionsBuilder

endOptionalAttachmentsInComment(StringBuilder) - Method in class org.revapi.maven.XmlSuggestionsBuilder

endReport(Sink) - Method in class org.revapi.maven.ReportMojo

epilogue(StringBuilder) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

epilogue(StringBuilder) - Method in class org.revapi.maven.JsonSuggestionsBuilder

epilogue(StringBuilder) - Method in class org.revapi.maven.XmlSuggestionsBuilder

execute() - Method in class org.revapi.maven.CheckMojo

execute() - Method in class org.revapi.maven.ConvertToXmlConfigMojo

execute() - Method in class org.revapi.maven.HelpMojo

execute() - Method in class org.revapi.maven.UpdateReleasePropertiesMojo

execute() - Method in class org.revapi.maven.ValidateConfigurationMojo

executeReport(Locale) - Method in class org.revapi.maven.ReportAggregateMojo

executeReport(Locale) - Method in class org.revapi.maven.ReportMojo

expandProperties - Variable in class org.revapi.maven.ReportMojo

If set to true, the Maven properties will be expanded in the configuration before it is supplied to Revapi.

F

failOnMissingConfigurationFiles - Variable in class org.revapi.maven.ReportMojo

Set to false if you want to tolerate files referenced in the analysisConfigurationFiles missing on the filesystem and therefore not contributing to the analysis configuration.

failOnUnresolvedArtifacts - Variable in class org.revapi.maven.ReportMojo

If true, the build will fail if one of the old or new artifacts fails to be resolved.

failOnUnresolvedDependencies - Variable in class org.revapi.maven.ReportMojo

If true, the build will fail if some of the dependencies of the old or new artifacts fail to be resolved.

FailSeverity - Enum in org.revapi.maven

findRevapi(MavenProject) - Static method in class org.revapi.maven.ReportAggregateMojo

G

generateSiteReport - Variable in class org.revapi.maven.ReportMojo

Set this to false if you want to use the goal to generate other kind of output than the default report for the Maven-generated site.

getAllProblemsMessage() - Method in class org.revapi.maven.BuildTimeReporter

getArtifacts(Xpp3Dom, String) - Static method in class org.revapi.maven.ReportAggregateMojo

getBundle(Locale) - Method in class org.revapi.maven.ReportMojo

getChangeLevel() - Method in class org.revapi.maven.ApiBreakageHintingReporter

getDescription(Locale) - Method in class org.revapi.maven.ReportAggregateMojo

getDescription(Locale) - Method in class org.revapi.maven.ReportMojo

getExtensionId() - Method in class org.revapi.maven.ApiBreakageHintingReporter

getExtensionId() - Method in class org.revapi.maven.BuildTimeReporter

getExtensionId() - Method in class org.revapi.maven.ConvertToXmlConfigMojo.SilentReporter

getExtensionId() - Method in class org.revapi.maven.ReportTimeReporter

getExtensionId() - Method in class org.revapi.maven.ValidateConfigurationMojo.ValidateReporter

getIgnoreSuggestion() - Method in class org.revapi.maven.BuildTimeReporter

getJSONSchema() - Method in class org.revapi.maven.ApiBreakageHintingReporter

getJSONSchema() - Method in class org.revapi.maven.BuildTimeReporter

getJSONSchema() - Method in class org.revapi.maven.ReportTimeReporter

getName(Locale) - Method in class org.revapi.maven.ReportMojo

getOutputDirectory() - Method in class org.revapi.maven.ReportAggregateMojo

getOutputDirectory() - Method in class org.revapi.maven.ReportMojo

getOutputName() - Method in class org.revapi.maven.ReportAggregateMojo

getOutputName() - Method in class org.revapi.maven.ReportMojo

getPath() - Method in class org.revapi.maven.ConfigurationFile

getProject() - Method in class org.revapi.maven.ReportMojo

getProjectArtifactCoordinates(MavenProject, String) - Static method in class org.revapi.maven.Analyzer

getReportOutputDirectory() - Method in class org.revapi.maven.ReportAggregateMojo

getResolvedNewApi() - Method in class org.revapi.maven.Analyzer

getResolvedOldApi() - Method in class org.revapi.maven.Analyzer

getResource() - Method in class org.revapi.maven.ConfigurationFile

getRevapi() - Method in class org.revapi.maven.Analyzer

getRoots() - Method in class org.revapi.maven.ConfigurationFile

H

hasBreakingProblems() - Method in class org.revapi.maven.BuildTimeReporter

HelpMojo - Class in org.revapi.maven

Display help information on revapi-maven-plugin.
Call mvn revapi:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.revapi.maven.HelpMojo

I

initialize(AnalysisContext) - Method in class org.revapi.maven.ApiBreakageHintingReporter

initialize(AnalysisContext) - Method in class org.revapi.maven.BuildTimeReporter

initialize(AnalysisContext) - Method in class org.revapi.maven.ReportTimeReporter

interpolate(String) - Method in class org.revapi.maven.PropertyValueInterpolator

J

JsonSuggestionsBuilder - Class in org.revapi.maven

A helper to BuildTimeReporter that outputs the ignore suggestions in JSON format.

JsonSuggestionsBuilder() - Constructor for class org.revapi.maven.JsonSuggestionsBuilder

N

newArtifacts - Variable in class org.revapi.maven.ReportMojo

The coordinates of the new artifacts.

newVersion - Variable in class org.revapi.maven.ReportMojo

The new version of the artifact.

niceList(Iterable<? extends Archive>) - Method in class org.revapi.maven.ReportMojo

O

oldArtifacts - Variable in class org.revapi.maven.ReportMojo

The coordinates of the old artifacts.

oldVersion - Variable in class org.revapi.maven.ReportMojo

If you don't want to compare a different artifact than the one being built, specifying the just the old version is simpler way of specifying the old artifact.

org.revapi.maven - package org.revapi.maven

OUTPUT_NON_IDENTIFYING_ATTACHMENTS - Static variable in class org.revapi.maven.BuildTimeReporter

outputDirectory - Variable in class org.revapi.maven.ReportMojo

P

pipelineConfiguration - Variable in class org.revapi.maven.ReportMojo

The JSON or XML configuration of the extensions pipeline.

prepareAnalyzer(Locale) - Method in class org.revapi.maven.ReportMojo

prologue(StringBuilder) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

prologue(StringBuilder) - Method in class org.revapi.maven.JsonSuggestionsBuilder

prologue(StringBuilder) - Method in class org.revapi.maven.XmlSuggestionsBuilder

PropertyValueInterpolator - Class in org.revapi.maven

This serves no other purpose but to make available the standard value sources for interpolating the properites in the Revapi configuration files.

PropertyValueInterpolator(Properties) - Constructor for class org.revapi.maven.PropertyValueInterpolator

PropertyValueInterpolator(MavenProject) - Constructor for class org.revapi.maven.PropertyValueInterpolator

R

report(Report) - Method in class org.revapi.maven.ApiBreakageHintingReporter

report(Report) - Method in class org.revapi.maven.BuildTimeReporter

report(Report) - Method in class org.revapi.maven.ReportTimeReporter

ReportAggregateMojo - Class in org.revapi.maven

Uses the configuration supplied at the top level aggregator project to run analysis on all sub-projects.

ReportAggregateMojo() - Constructor for class org.revapi.maven.ReportAggregateMojo

reportBody(ReportTimeReporter, API, API, Sink, ResourceBundle) - Method in class org.revapi.maven.ReportAggregateMojo

reportBody(ReportTimeReporter, API, API, Sink, ResourceBundle) - Method in class org.revapi.maven.ReportMojo

reportCriticality - Variable in class org.revapi.maven.ReportMojo

The minimum criticality of the differences that should be included in the report.

ReportForkMojo - Class in org.revapi.maven

ReportForkMojo() - Constructor for class org.revapi.maven.ReportForkMojo

ReportMojo - Class in org.revapi.maven

ReportMojo() - Constructor for class org.revapi.maven.ReportMojo

reportSeverity - Variable in class org.revapi.maven.ReportMojo

Deprecated.

use ReportMojo.reportCriticality instead

ReportTimeReporter - Class in org.revapi.maven

ReportTimeReporter() - Constructor for class org.revapi.maven.ReportTimeReporter

ReportTimeReporter.DifferenceReport - Class in org.revapi.maven

repositorySystem - Variable in class org.revapi.maven.ReportMojo

repositorySystemSession - Variable in class org.revapi.maven.ReportMojo

resolveProvidedDependencies - Variable in class org.revapi.maven.ReportMojo

When establishing the API classes, Revapi by default also looks through the provided dependencies.

resolveTransitiveProvidedDependencies - Variable in class org.revapi.maven.ReportMojo

In addition to ReportMojo.resolveProvidedDependencies this property further controls how provided dependencies are resolved.

S

setPath(String) - Method in class org.revapi.maven.ConfigurationFile

setReportOutputDirectory(File) - Method in class org.revapi.maven.ReportAggregateMojo

setResource(String) - Method in class org.revapi.maven.ConfigurationFile

setRoots(String[]) - Method in class org.revapi.maven.ConfigurationFile

SilentReporter() - Constructor for class org.revapi.maven.ConvertToXmlConfigMojo.SilentReporter

skip - Variable in class org.revapi.maven.ReportMojo

Whether to skip the mojo execution.

startDifference(StringBuilder) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

startDifference(StringBuilder) - Method in class org.revapi.maven.JsonSuggestionsBuilder

startDifference(StringBuilder) - Method in class org.revapi.maven.XmlSuggestionsBuilder

startOptionalAttachmentsInComment(StringBuilder, String) - Method in class org.revapi.maven.AbstractSuggestionsBuilder

startOptionalAttachmentsInComment(StringBuilder, String) - Method in class org.revapi.maven.JsonSuggestionsBuilder

startOptionalAttachmentsInComment(StringBuilder, String) - Method in class org.revapi.maven.XmlSuggestionsBuilder

startReport(Sink, ResourceBundle) - Method in class org.revapi.maven.ReportMojo

SuggestionBuilderContext() - Constructor for class org.revapi.maven.BuildTimeReporter.SuggestionBuilderContext

SUGGESTIONS_BUILDER_KEY - Static variable in class org.revapi.maven.BuildTimeReporter

U

UpdateReleasePropertiesMojo - Class in org.revapi.maven

UpdateReleasePropertiesMojo() - Constructor for class org.revapi.maven.UpdateReleasePropertiesMojo

UpdateVersionsMojo - Class in org.revapi.maven

UpdateVersionsMojo() - Constructor for class org.revapi.maven.UpdateVersionsMojo

V

ValidateConfigurationMojo - Class in org.revapi.maven

ValidateConfigurationMojo() - Constructor for class org.revapi.maven.ValidateConfigurationMojo

ValidateConfigurationMojo.ValidateReporter - Class in org.revapi.maven

ValidateReporter() - Constructor for class org.revapi.maven.ValidateConfigurationMojo.ValidateReporter

valueOf(String) - Static method in enum org.revapi.maven.ApiChangeLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.revapi.maven.FailSeverity

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.revapi.maven.ApiChangeLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.revapi.maven.FailSeverity

Returns an array containing the constants of this enum type, in the order they are declared.

versionFormat - Variable in class org.revapi.maven.ReportMojo

If set, this property demands a format of the version string when the ReportMojo.oldVersion or ReportMojo.newVersion parameters are set to RELEASE or LATEST special version strings.

X

XmlSuggestionsBuilder - Class in org.revapi.maven

A helper to BuildTimeReporter that outputs the ignore suggestions in XML format.

XmlSuggestionsBuilder() - Constructor for class org.revapi.maven.XmlSuggestionsBuilder

A B C D E F G H I J N O P R S U V X