All Classes

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
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.Role	The role of the archive in the API.
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.
BaseApiAnalyzer<E extends Element<E>>	A convenience base class for API analyzers.
BaseArchiveAnalyzer<F extends BaseElementForest<E>,E extends Element<E>>	A convenience base class for API analyzers.
BaseConfigurable	A convenience base class for all configurable types in Revapi.
BaseDifferenceAnalyzer<E extends Element<E>>	A convenience base class for difference analyzers analyzers.
BaseDifferenceTransform<E extends Element<E>>	A convenience base class for difference transforms
BaseEagerLoadingArchiveAnalyzer<F extends BaseElementForest<E>,E extends BaseElement<E>>	A base class for archive analyzers that need to load all the elements in an archive eagerly.
BaseElement<E extends Element<E>>	A base class for API elements.
BaseElementForest<E extends Element<E>>	A convenience base class for element forest implementations.
BaseElementMatcher	A convenience base class for element matchers.
BaseReporter	A convenience base class for reporters.
BaseTreeFilter<E extends Element<E>>	A convenience base class for tree filters.
BaseTreeFilterProvider	A convenience base class for tree filter providers.
CoIterator<E>	Heavily inspired by the equivalently named class in Clirr 0.6.
CollectingReporter	This is a simple helper class that can be used by the users to collect all the reports from Revapi.
CompatibilityType	Enumerates possible compatibility types.
Configurable	A thing that can be configured from a JSON file.
ConfigurationException	Thrown if an invalid configuration is detected.
ConfigurationValidator
CorrespondenceComparatorDeducer<E extends Element<E>>	A correspondence comparator deducer produces a comparator that is used to compare elements from 2 collections.
Criticality	Criticality represents the assigned importance of a Difference.
DFSFilteringIterator<E extends Element>	Deprecated. This always had very limited utility and Element.stream(Class, boolean) seems to be a more usable alternative.
Difference	Represents a single difference between an old and new API element.
Difference.Builder
Difference.InReportBuilder
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.
DifferenceSeverity	Enumerates the possible severities of differences found during the API analysis.
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.
ElementPair	A simple pair of elements.
FileArchive	A simple implementation of the Archive interface providing a file as a Revapi archive.
Filter<T>	Deprecated. Filtering turned out to be not that usable and will be removed.
FilterFinishResult	A result of a finished filtering (see TreeFilter.finish(Element).
FilteringIterator<E>	Deprecated. Filtering turned out to be more complex than this.
FilterStartResult	The result of the element filtering in TreeFilter.
IncludeExcludeTreeFilter<E extends Element<E>>	A tree filter that uses a combination of an include and exclude filters to arrive at the filtering decisions.
IncludeExcludeTreeFilter.IncludeExcludeResult
IndependentTreeFilter<E extends Element<E>>	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.
InputStreamArchive	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.
JSONUtil	A utility class for JSON files.
OverridableIncludeExcludeTreeFilter<E extends Element<E>>	This is similar to the IncludeExcludeTreeFilter but adds support for the "include inside exclude", e.g.
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.
Reference.Type<E extends Element<E>>	Represents the type of the relationship between two elements.
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
ReportComparator.Strategy	The comparison strategy defines the way the elements of the same type are compared with each other.
Reporter	A reporter is the final stage during the API change analysis.
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).
SimpleConfigurable	Deprecated. use BaseConfigurable instead
SimpleDifferenceTransform<T extends Element<T>>	Deprecated. use BaseDifferenceTransform instead
SimpleElement	Deprecated. use BaseElement instead
SimpleElementFilter	Deprecated. use IndependentTreeFilter or some other TreeFilter instead
SimpleElementForest	Deprecated. use BaseElementForest instead
SimpleReporter	Deprecated. use BaseReporter instead
Stats	Quick and dirty execution time statistics collection class.
Stats.Collector
Ternary	Ternary logic using the Kleene algebra.
TransformationResult	The result of an transformation.
TransformationResult.Resolution	The resolution of the difference transformation
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.
ValidationResult	Represents the results of the the configuration validation.
ValidationResult.Error
XmlToJson<Xml>	A tool to convert some XML representation of the Revapi configuration to JsonNode used by Revapi.
XmlToJson.JSONPointer	Deprecated. use Jackson's impl
ZipArchiveAnalyzer<F extends BaseElementForest<E>,E extends BaseElement<E>>	This is a base class for archive analyzers that need to search for files in a zipped archive.