All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description AnalysisContextAn analysis context is an aggregation of the APIs to check and configuration for the analysis. AnalysisContext.Builder AnalysisResultHolds the result of the analysis. AnalysisResult.ExtensionInstance<I> AnalysisResult.Extensions APIRepresents 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. ArchiveA simple abstraction of a file or archive. Archive.RoleThe role of the archive in the API. Archive.VersionedExtension 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. BaseConfigurableA 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. BaseElementMatcherA convenience base class for element matchers. BaseReporterA convenience base class for reporters. BaseTreeFilter<E extends Element<E>>A convenience base class for tree filters. BaseTreeFilterProviderA convenience base class for tree filter providers. CoIterator<E>Heavily inspired by the equivalently named class in Clirr 0.6. CollectingReporterThis is a simple helper class that can be used by the users to collect all the reports from Revapi. CompatibilityTypeEnumerates possible compatibility types. ConfigurableA thing that can be configured from a JSON file. ConfigurationExceptionThrown 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. CriticalityCriticality represents the assigned importance of a
DFSFilteringIterator<E extends Element> Deprecated.This always had very limited utility and
Element.stream(Class, boolean)seems to be a more usable alternative.
DifferenceRepresents 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. DifferenceSeverityEnumerates 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
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. ElementMatcherAn element matcher is a helper extension to other extensions that need to figure out if a certain element meets certain criteria. ElementMatcher.CompiledRecipeA "compiled" representation of a textual recipe. ElementPairA simple pair of elements. FileArchiveA simple implementation of the
Archiveinterface providing a file as a Revapi archive.
Filter<T> Deprecated.Filtering turned out to be not that usable and will be removed. FilterFinishResultA result of a finished filtering (see
FilteringIterator<E> Deprecated.Filtering turned out to be more complex than this. FilterStartResultThe result of the element filtering in
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>> InputStreamArchiveA simple implementation of the
Archiveinterface that uses a "factory" supplier that is able to return a new input stream representing the archive every time it is called.
JSONUtilA utility class for JSON files. OverridableIncludeExcludeTreeFilter<E extends Element<E>>This is similar to the
IncludeExcludeTreeFilterbut adds support for the "include inside exclude", e.g.
PipelineConfigurationThis 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. ReportRepresents the differences between comparable elements from old and new API. Report.Builder ReportComparatorWhile
elementsof a single API analyzer are by definition mutually comparable, the same doesn't apply for reports.
ReportComparator.Builder ReportComparator.StrategyThe comparison strategy defines the way the elements of the same type are compared with each other. ReporterA reporter is the final stage during the API change analysis. RevapiThe main entry point to the library. Revapi.Builder Deprecated.favor the
ServiceTypeLoader<T>Because Revapi manages the lifecycle of instances of its extensions, it cannot unfortunately use the
ServiceLoaderdirectly (before Java 9 which enhances it to support the use case Revapi needs).
SimpleDifferenceTransform<T extends Element<T>> Deprecated.use
SimpleElementFilter Deprecated. SimpleElementForest Deprecated.use
StatsQuick and dirty execution time statistics collection class. Stats.Collector TernaryTernary logic using the Kleene algebra. TransformationResultThe result of an transformation. TransformationResult.ResolutionThe 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. TreeFilterProviderForest filter helps the
ArchiveAnalyzerfilter the resulting element forest while it is being created.
ValidationResultRepresents the results of the the configuration validation. ValidationResult.Error XmlToJson<Xml>A tool to convert some XML representation of the Revapi configuration to
JsonNodeused 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.