public interface ApiAnalyzer extends AutoCloseable, Configurable
The API analyzer is a kind of "hub" that, once configured, produces archive analyzers to crack open the API archives and generate an element tree from them. Later on during the analysis the API analyzer is asked to create a difference analyzer that will be responsible to check pairs of comparable elements, each coming from the different version of the API.
The AutoCloseable.close()
is not called if there is no prior call to Configurable.initialize(AnalysisContext)
. Do all your
resource acquisition in initialize, not during the construction of the object.
Modifier and Type | Method and Description |
---|---|
ArchiveAnalyzer |
getArchiveAnalyzer(API api)
This method is called exactly twice during the API difference analysis.
|
CorrespondenceComparatorDeducer |
getCorrespondenceDeducer()
The correspondence sorter to use when finalizing the comparison order of the elements in the element forest.
|
DifferenceAnalyzer |
getDifferenceAnalyzer(ArchiveAnalyzer oldArchive,
ArchiveAnalyzer newArchive)
This method is called exactly once during the API difference analysis and produces an element analyzer which
will be used to compare the corresponding elements in the old and new archives.
|
close
getExtensionId, getJSONSchema, initialize
@Nonnull ArchiveAnalyzer getArchiveAnalyzer(@Nonnull API api)
api
- the api to analyze@Nonnull DifferenceAnalyzer getDifferenceAnalyzer(@Nonnull ArchiveAnalyzer oldArchive, @Nonnull ArchiveAnalyzer newArchive)
oldArchive
- the analyzer used for the old archivesnewArchive
- the analyzer used for the new archives@Nonnull CorrespondenceComparatorDeducer getCorrespondenceDeducer()
Copyright © 2014-2020 Lukas Krejci. All Rights Reserved.