Package | Description |
---|---|
org.revapi | |
org.revapi.base | |
org.revapi.query | |
org.revapi.simple |
Modifier and Type | Interface and Description |
---|---|
interface |
ApiAnalyzer<E extends Element<E>>
An API analyzer is the main interface one has to implement to support checking some kind of API.
|
interface |
ArchiveAnalyzer<E extends Element<E>>
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. |
interface |
CorrespondenceComparatorDeducer<E extends Element<E>>
A correspondence comparator deducer produces a comparator that is used to compare elements from 2 collections.
|
interface |
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.
|
interface |
DifferenceTransform<E extends Element<?>>
A difference transform may elect to transform certain kinds of differences into other kinds.
|
static interface |
DifferenceTransform.TraversalTracker<E extends Element<E>>
Some more sophisticated transforms may need to track the traversal of the element forest.
|
interface |
Element<E extends Element<E>>
An element in a forest representation of given "language" under API inspection.
|
interface |
ElementForest<E extends Element<E>>
A representation of some "unit" understood by an API analyzer.
|
static interface |
ElementForest.Visitor<E extends Element<E>>
A visitor of the element forest.
|
interface |
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.
|
Modifier and Type | Method and Description |
---|---|
default <T extends Element<?>> |
Element.as(Class<T> type)
Casts this element to the provided type.
|
protected <E extends Element<E>> |
ReportComparator.compare(E e1,
E e2)
Compares the two elements based on the comparison strategy.
|
<E extends Element<E>> |
ReportComparator.Builder.comparingElements(Class<E> elementBaseType,
Comparator<E> comparator)
Sets up the report comparator with a custom comparator for a certain types of report elements.
|
static <E extends Element<E>> |
ElementForest.empty(API api) |
<E extends Element<E>> |
ElementMatcher.CompiledRecipe.filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
The recipe needs to be transformed into a
TreeFilter to be used for filtering of the element forest. |
<E extends Element<E>> |
TreeFilterProvider.filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
Creates a new filter specifically for use with the provided analyzer.
|
default <E extends Element<E>> |
ElementFilter.filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
Deprecated.
|
protected <E extends Element<E>> |
ReportComparator.getComparatorFor(E element) |
<T extends Element<E>> |
Element.iterateOverChildren(Class<T> resultType,
boolean recurse,
Filter<? super T> filter)
Deprecated.
use the more standard
stream(Class, boolean) |
default <T extends Element<T>> |
ElementForest.iterateOverElements(Class<T> resultType,
boolean recurse,
Filter<? super T> filter,
Element<T> searchRoot)
Deprecated.
use the more versatile
ElementForest.stream(Class, boolean, Element) |
static <E extends Element<E>> |
TreeFilter.matchAndDescend() |
static <E extends Element<E>> |
CorrespondenceComparatorDeducer.naturalOrder() |
default <T extends Element<T>> |
ElementForest.search(Class<T> resultType,
boolean recurse,
Filter<? super T> filter,
Element<T> searchRoot)
Deprecated.
in favor of more versatile
ElementForest.stream(Class, boolean, Element) |
<T extends Element<E>> |
Element.searchChildren(Class<T> resultType,
boolean recurse,
Filter<? super T> filter)
Deprecated.
in favor of
stream(Class, boolean) |
<T extends Element<E>> |
Element.searchChildren(List<T> results,
Class<T> resultType,
boolean recurse,
Filter<? super T> filter)
Deprecated.
in favor of
stream(Class, boolean) |
default <X extends Element<X>> |
DifferenceTransform.startTraversal(ApiAnalyzer<X> apiAnalyzer,
ArchiveAnalyzer<X> oldArchiveAnalyzer,
ArchiveAnalyzer<X> newArchiveAnalyzer)
Called when Revapi is about to start traversing the elements provided by the given archive analyzers.
|
default <T extends Element<E>> |
Element.stream(Class<T> elementType,
boolean recurse)
A stream equivalent of
iterateOverChildren(Class, boolean, Filter) . |
default <T extends Element<E>> |
ElementForest.stream(Class<T> resultType,
boolean recurse,
Element<E> searchRoot) |
<T extends Element<E>> |
ElementForest.stream(Class<T> resultType,
boolean recurse,
TreeFilter<E> filter,
Element<E> root)
Walks through the forest and returns a stream of elements that match the provided filter.
|
static <E extends Element<E>> |
TreeFilter.union(List<TreeFilter<E>> fs) |
static <E extends Element<E>> |
TreeFilter.union(TreeFilter<E>... fs) |
static <E extends Element<E>> |
ElementForest.walk(E root,
ElementForest.Visitor<E> visitor) |
static <E extends Element<E>> |
ElementForest.walk(ElementForest<E> forest,
ElementForest.Visitor<E> visitor) |
Modifier and Type | Method and Description |
---|---|
protected Element<?> |
ReportComparator.getElement(Report report)
Returns the new element or, if the new element is null, the old element of the report.
|
Element |
ElementPair.getNewElement() |
Element<?> |
Report.getNewElement() |
Element |
ElementPair.getOldElement() |
Element<?> |
Report.getOldElement() |
Modifier and Type | Method and Description |
---|---|
protected int |
ReportComparator.defaultCompareIncomparable(Element<?> el1,
Element<?> el2)
This method is called to compare the two elements that are of different base types and no explicit order has been
set for the base types.
|
protected int |
ReportComparator.defaultCompareIncomparable(Element<?> el1,
Element<?> el2)
This method is called to compare the two elements that are of different base types and no explicit order has been
set for the base types.
|
default <T extends Element<T>> |
ElementForest.iterateOverElements(Class<T> resultType,
boolean recurse,
Filter<? super T> filter,
Element<T> searchRoot)
Deprecated.
use the more versatile
ElementForest.stream(Class, boolean, Element) |
default <T extends Element<T>> |
ElementForest.search(Class<T> resultType,
boolean recurse,
Filter<? super T> filter,
Element<T> searchRoot)
Deprecated.
in favor of more versatile
ElementForest.stream(Class, boolean, Element) |
default <T extends Element<E>> |
ElementForest.stream(Class<T> resultType,
boolean recurse,
Element<E> searchRoot) |
<T extends Element<E>> |
ElementForest.stream(Class<T> resultType,
boolean recurse,
TreeFilter<E> filter,
Element<E> root)
Walks through the forest and returns a stream of elements that match the provided filter.
|
Report.Builder |
Report.Builder.withNew(Element<?> element) |
Report.Builder |
Report.Builder.withOld(Element<?> element) |
Constructor and Description |
---|
ElementPair(Element oldElement,
Element newElement) |
ElementPair(Element oldElement,
Element newElement) |
Report(Iterable<Difference> problems,
Element<?> oldElement,
Element<?> newElement) |
Report(Iterable<Difference> problems,
Element<?> oldElement,
Element<?> newElement) |
Modifier and Type | Class and Description |
---|---|
class |
BaseApiAnalyzer<E extends Element<E>>
A convenience base class for API analyzers.
|
class |
BaseDifferenceAnalyzer<E extends Element<E>>
A convenience base class for difference analyzers analyzers.
|
class |
BaseDifferenceTransform<E extends Element<E>>
A convenience base class for difference transforms
|
class |
BaseElement<E extends Element<E>>
A base class for API elements.
|
class |
BaseElementForest<E extends Element<E>>
A convenience base class for element forest implementations.
|
class |
BaseTreeFilter<E extends Element<E>>
A convenience base class for tree filters.
|
class |
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. |
Modifier and Type | Class and Description |
---|---|
class |
BaseElement<E extends Element<E>>
A base class for API elements.
|
Modifier and Type | Method and Description |
---|---|
<E extends Element<E>> |
BaseTreeFilterProvider.filterFor(ArchiveAnalyzer<E> archiveAnalyzer) |
<T extends Element<E>> |
BaseElement.iterateOverChildren(Class<T> resultType,
boolean recurse,
Filter<? super T> filter) |
protected <T extends Element<E>> |
BaseElementForest.search(List<T> results,
Class<T> resultType,
SortedSet<E> siblings,
boolean recurse,
TreeFilter<E> filter) |
<T extends Element<E>> |
BaseElement.searchChildren(Class<T> resultType,
boolean recurse,
Filter<? super T> filter) |
<T extends Element<E>> |
BaseElement.searchChildren(List<T> results,
Class<T> resultType,
boolean recurse,
Filter<? super T> filter) |
<T extends Element<E>> |
BaseElementForest.stream(Class<T> resultType,
boolean recurse,
TreeFilter<E> filter,
Element<E> root) |
Modifier and Type | Method and Description |
---|---|
<T extends Element<E>> |
BaseElementForest.stream(Class<T> resultType,
boolean recurse,
TreeFilter<E> filter,
Element<E> root) |
Modifier and Type | Class and Description |
---|---|
class |
DFSFilteringIterator<E extends Element>
Deprecated.
This always had very limited utility and
stream(Class, boolean) seems to be a more usable
alternative. |
Constructor and Description |
---|
DFSFilteringIterator(Iterator<? extends Element> rootIterator,
Class<? extends E> resultClass,
Filter<? super E> filter)
Deprecated.
Constructor.
|
Modifier and Type | Class and Description |
---|---|
class |
SimpleDifferenceTransform<T extends Element<T>>
Deprecated.
use
BaseDifferenceTransform instead |
Modifier and Type | Class and Description |
---|---|
class |
SimpleElement
Deprecated.
use
BaseElement instead |
Modifier and Type | Method and Description |
---|---|
protected <T extends Element> |
SimpleElement.getDirectChildrenOfType(Class<T> type)
Deprecated.
|
<T extends Element> |
SimpleElementForest.search(Class<T> resultType,
boolean recurse,
TreeFilter filter,
Element root)
Deprecated.
|
<T extends Element> |
SimpleElementForest.search(List<T> results,
Class<T> resultType,
SortedSet<? extends Element> currentLevel,
boolean recurse,
Filter<? super T> filter)
Deprecated.
|
<T extends Element> |
SimpleElementForest.search(List<T> results,
Class<T> resultType,
SortedSet<? extends Element> currentLevel,
boolean recurse,
TreeFilter filter)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Element |
SimpleElement.getParent()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
SortedSet<? extends Element> |
SimpleElement.getChildren()
Deprecated.
This default implementation uses the
SimpleElement.newChildrenInstance() to initialize the children set and wraps
it in a private set implementation that automagically changes the parent of the elements based on the
membership. |
protected SortedSet<Element> |
SimpleElement.newChildrenInstance()
Deprecated.
Override this method if you need some specialized instance of sorted set or want to do some custom pre-populating
or initialization of the children.
|
Modifier and Type | Method and Description |
---|---|
boolean |
SimpleElementFilter.applies(Element<?> element)
Deprecated.
|
<T extends Element> |
SimpleElementForest.search(Class<T> resultType,
boolean recurse,
TreeFilter filter,
Element root)
Deprecated.
|
void |
SimpleElement.setParent(Element parent)
Deprecated.
Sets the parent element.
|
java.util.stream.Stream |
SimpleElementForest.stream(Class resultType,
boolean recurse,
TreeFilter filter,
Element root)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
<T extends Element> |
SimpleElementForest.search(List<T> results,
Class<T> resultType,
SortedSet<? extends Element> currentLevel,
boolean recurse,
Filter<? super T> filter)
Deprecated.
|
<T extends Element> |
SimpleElementForest.search(List<T> results,
Class<T> resultType,
SortedSet<? extends Element> currentLevel,
boolean recurse,
TreeFilter filter)
Deprecated.
|
Copyright © 2014-2021 Lukas Krejci. All Rights Reserved.