Package org.revapi

Interface Summary

Interface	Description
ApiAnalyzer<E extends Element<E>>	An API analyzer is the main interface one has to implement to support checking some kind of API.
Archive	A simple abstraction of a file or archive.
Archive.Versioned	Extension of the archive interface that can also provide the version of the archive.
ArchiveAnalyzer<E extends Element<E>>	The instances of implementations of this interface are produced by the ApiAnalyzers to analyze the API archives and create an element tree that is then used for API comparison.
CorrespondenceComparatorDeducer<E extends Element<E>>	A correspondence comparator deducer produces a comparator that is used to compare elements from 2 collections.
DifferenceAnalyzer<E extends Element<E>>	An element analyzer is basically a visitor over matching elements of some language between the two API versions being compared.
DifferenceTransform<E extends Element<?>>	A difference transform may elect to transform certain kinds of differences into other kinds.
DifferenceTransform.TraversalTracker<E extends Element<E>>	Some more sophisticated transforms may need to track the traversal of the element forest.
Element<E extends Element<E>>	An element in a forest representation of given "language" under API inspection.
ElementFilter	Deprecated. use TreeFilterProvider instead
ElementForest<E extends Element<E>>	A representation of some "unit" understood by an API analyzer.
ElementForest.Visitor<E extends Element<E>>	A visitor of the element forest.
ElementMatcher	An element matcher is a helper extension to other extensions that need to figure out if a certain element meets certain criteria.
ElementMatcher.CompiledRecipe	A "compiled" representation of a textual recipe.
Reference.Type<E extends Element<E>>	Represents the type of the relationship between two elements.
Reporter	A reporter is the final stage during the API change analysis.
TreeFilter<E extends Element<E>>	A tree filter is something that is called repeatedly by the caller as the caller walks a tree of elements in a depth first search manner.
TreeFilterProvider	Forest filter helps the ArchiveAnalyzer filter the resulting element forest while it is being created.

Class Summary

Class	Description
AnalysisContext	An analysis context is an aggregation of the APIs to check and configuration for the analysis.
AnalysisContext.Builder
AnalysisResult	Holds the result of the analysis.
AnalysisResult.ExtensionInstance<I>
AnalysisResult.Extensions
API	Represents a set of archives that define an API.
API.Builder
CoIterator<E>	Heavily inspired by the equivalently named class in Clirr 0.6.
Criticality	Criticality represents the assigned importance of a Difference.
Difference	Represents a single difference between an old and new API element.
Difference.Builder
Difference.InReportBuilder
ElementPair	A simple pair of elements.
FilterFinishResult	A result of a finished filtering (see TreeFilter.finish(Element).
FilterStartResult	The result of the element filtering in TreeFilter.
PipelineConfiguration	This class represents the configuration of the Revapi analysis pipeline.
PipelineConfiguration.Builder
Reference<E extends Element<E>>	Represents a reference between two elements determined in some way by the API analyzer.
Report	Represents the differences between comparable elements from old and new API.
Report.Builder
ReportComparator	While elements of a single API analyzer are by definition mutually comparable, the same doesn't apply for reports.
ReportComparator.Builder
Revapi	The main entry point to the library.
Revapi.Builder	Deprecated. favor the PipelineConfiguration.Builder
ServiceTypeLoader<T>	Because Revapi manages the lifecycle of instances of its extensions, it cannot unfortunately use the ServiceLoader directly (before Java 9 which enhances it to support the use case Revapi needs).
Stats	Quick and dirty execution time statistics collection class.
Stats.Collector
TransformationResult	The result of an transformation.

Enum Summary

Enum	Description
Archive.Role	The role of the archive in the API.
CompatibilityType	Enumerates possible compatibility types.
DifferenceSeverity	Enumerates the possible severities of differences found during the API analysis.
ReportComparator.Strategy	The comparison strategy defines the way the elements of the same type are compared with each other.
Ternary	Ternary logic using the Kleene algebra.
TransformationResult.Resolution	The resolution of the difference transformation