All Classes and Interfaces
Class
Description
An analysis context is an aggregation of the APIs to check and configuration for the analysis.
Holds the result of the analysis.
Represents a set of archives that define an API.
An API analyzer is the main interface one has to implement to support checking some kind of API.
A simple abstraction of a file or archive.
The role of the archive in the API.
Extension of the archive interface that can also provide the version of the archive.
The instances of implementations of this interface are produced by the
ApiAnalyzer
s to analyze the
API archives and create an element tree that is then used for API comparison.A convenience base class for API analyzers.
A convenience base class for API analyzers.
A convenience base class for all configurable types in Revapi.
A convenience base class for difference analyzers analyzers.
A convenience base class for difference transforms
A base class for archive analyzers that need to load all the elements in an archive eagerly.
A base class for API elements.
A convenience base class for element forest implementations.
A convenience base class for element matchers.
A convenience base class for reporters.
A convenience base class for tree filters.
A convenience base class for tree filter providers.
Heavily inspired by the equivalently named class in Clirr 0.6.
This is a simple helper class that can be used by the users to collect all the reports from Revapi.
Enumerates possible compatibility types.
A thing that can be configured from a JSON file.
Thrown if an invalid configuration is detected.
A correspondence comparator deducer produces a comparator that is used to compare elements from 2 collections.
Criticality represents the assigned importance of a
Difference
.Deprecated.
Represents a single difference between an old and new API element.
An element analyzer is basically a visitor over matching elements of some language between the two API versions being
compared.
Enumerates the possible severities of differences found during the API analysis.
A difference transform may elect to transform certain kinds of differences into other kinds.
Some more sophisticated transforms may need to track the traversal of the element forest.
An element in a forest representation of given "language" under API inspection.
Deprecated.
use
TreeFilterProvider
insteadA representation of some "unit" understood by an API analyzer.
A visitor of the element forest.
An element matcher is a helper extension to other extensions that need to figure out if a certain element meets
certain criteria.
A "compiled" representation of a textual recipe.
A simple pair of elements.
A simple implementation of the
Archive
interface providing a file as a Revapi archive.Deprecated.
Filtering turned out to be not that usable and will be removed.
A result of a finished filtering (see
TreeFilter.finish(Element)
.Deprecated.
Filtering turned out to be more complex than this.
The result of the element filtering in
TreeFilter
.A tree filter that uses a combination of an include and exclude filters to arrive at the filtering decisions.
A simple implementation of the
TreeFilter
interface that simply repeats the result provided from the
IndependentTreeFilter.start(Element)
method in its IndependentTreeFilter.finish(Element)
method.A simple implementation of the
Archive
interface that uses a "factory" supplier that is able to return a new
input stream representing the archive every time it is called.A utility class for JSON files.
This is similar to the
IncludeExcludeTreeFilter
but adds support for the "include inside exclude", e.g.This class represents the configuration of the Revapi analysis pipeline.
Represents a reference between two elements determined in some way by the API analyzer.
Represents the type of the relationship between two elements.
Represents the differences between comparable elements from old and new API.
While
elements
of a single API analyzer are by definition mutually comparable, the same
doesn't apply for reports.The comparison strategy defines the way the elements of the same type are compared with each other.
A reporter is the final stage during the API change analysis.
The main entry point to the library.
Deprecated.
favor the
PipelineConfiguration.Builder
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).Deprecated.
use
BaseConfigurable
insteadDeprecated.
use
BaseDifferenceTransform
insteadDeprecated.
use
BaseElement
insteadDeprecated.
use
IndependentTreeFilter
or some other TreeFilter
insteadDeprecated.
use
BaseElementForest
insteadDeprecated.
use
BaseReporter
insteadQuick and dirty execution time statistics collection class.
Ternary logic using the Kleene algebra.
The result of an transformation.
The resolution of the difference transformation
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.
Forest filter helps the
ArchiveAnalyzer
filter the resulting element forest while it is being created.Represents the results of the the configuration validation.
A tool to convert some XML representation of the Revapi configuration to
JsonNode
used by Revapi.Deprecated.
use Jackson's impl
This is a base class for archive analyzers that need to search for files in a zipped archive.
Element.stream(Class, boolean)
seems to be a more usable alternative.