Uses of Interface
org.revapi.Element

Packages that use Element

Package	Description
org.revapi
org.revapi.base
org.revapi.query
org.revapi.simple

Uses of Element in org.revapi

Classes in org.revapi with type parameters of type Element

Modifier and Type	Interface	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 ApiAnalyzers 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.
class	Reference<E extends Element<E>>	Represents a reference between two elements determined in some way by the API analyzer.
static interface	Reference.Type<E extends Element<E>>	Represents the type of the relationship between two elements.
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.

Methods in org.revapi with type parameters of type Element

Modifier and Type	Method	Description
default <T extends Element<?>> T	Element.as(Class<T> type)	Casts this element to the provided type.
protected <E extends Element<E>> int	ReportComparator.compare(E e1, E e2)	Compares the two elements based on the comparison strategy.
<E extends Element<E>> ReportComparator.Builder	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>> CorrespondenceComparatorDeducer<E>	CorrespondenceComparatorDeducer.editDistance(BiPredicate<? super E,? super E> equality)	This correspondence deducer is a good match for situations where the ordering of the children of some element is not semantic but rather positional, e.g.
static <E extends Element<E>> ElementForest<E>	ElementForest.empty(API api)
default <E extends Element<E>> Optional<TreeFilter<E>>	ElementFilter.filterFor(ArchiveAnalyzer<E> archiveAnalyzer)	Deprecated.
<E extends Element<E>> TreeFilter<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>> Optional<TreeFilter<E>>	TreeFilterProvider.filterFor(ArchiveAnalyzer<E> archiveAnalyzer)	Creates a new filter specifically for use with the provided analyzer.
protected <E extends Element<E>> Comparator<E>	ReportComparator.getComparatorFor(E element)
static <E extends Element<E>> TreeFilter<E>	TreeFilter.intersection(List<TreeFilter<E>> fs)	Returns a filter that matches if all of the provided filters match.
static <E extends Element<E>> TreeFilter<E>	TreeFilter.intersection(TreeFilter<E>... fs)
<T extends Element<E>> Iterator<T>	Element.iterateOverChildren(Class<T> resultType, boolean recurse, Filter<? super T> filter)	Deprecated. use the more standard stream(Class, boolean)
default <T extends Element<T>> Iterator<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<E>	TreeFilter.matchAndDescend()
static <E extends Element<E>> TreeFilter<E>	TreeFilter.merge(BinaryOperator<FilterStartResult> mergeStarts, BinaryOperator<FilterFinishResult> mergeFinishes, FilterStartResult defaultStartResult, FilterFinishResult defaultFinishResult, List<TreeFilter<E>> fs)	Merges the filters together using the provided functions to combine the individual results.
static <E extends Element<E>> TreeFilter<E>	TreeFilter.merge(BinaryOperator<FilterStartResult> mergeStarts, BinaryOperator<FilterFinishResult> mergeFinishes, FilterStartResult defaultStartResult, FilterFinishResult defaultFinishResult, TreeFilter<E>... fs)
static <E extends Element<E>> CorrespondenceComparatorDeducer<E>	CorrespondenceComparatorDeducer.naturalOrder()
default <T extends Element<T>> List<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>> List<T>	Element.searchChildren(Class<T> resultType, boolean recurse, Filter<? super T> filter)	Deprecated. in favor of stream(Class, boolean)
<T extends Element<E>> void	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>> Optional<DifferenceTransform.TraversalTracker<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>> Stream<T>	Element.stream(Class<T> elementType, boolean recurse)	A stream equivalent of iterateOverChildren(Class, boolean, Filter).
default <T extends Element<E>> Stream<T>	ElementForest.stream(Class<T> resultType, boolean recurse, Element<E> searchRoot)
<T extends Element<E>> Stream<T>	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<E>	TreeFilter.union(List<TreeFilter<E>> fs)
static <E extends Element<E>> TreeFilter<E>	TreeFilter.union(TreeFilter<E>... fs)
static <E extends Element<E>> void	ElementForest.walk(E root, ElementForest.Visitor<E> visitor)
static <E extends Element<E>> void	ElementForest.walk(ElementForest<E> forest, ElementForest.Visitor<E> visitor)

Methods in org.revapi that return Element

Modifier and Type	Method	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()

Methods in org.revapi with parameters of type Element

Modifier and Type	Method	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.
default <T extends Element<T>> Iterator<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>> List<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>> Stream<T>	ElementForest.stream(Class<T> resultType, boolean recurse, Element<E> searchRoot)
<T extends Element<E>> Stream<T>	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)

Constructors in org.revapi with parameters of type Element

Constructor	Description
ElementPair(Element oldElement, Element newElement)
Report(Iterable<Difference> problems, Element<?> oldElement, Element<?> newElement)

Uses of Element in org.revapi.base

Classes in org.revapi.base with type parameters of type Element

Modifier and Type	Class	Description
class	BaseApiAnalyzer<E extends Element<E>>	A convenience base class for API analyzers.
class	BaseArchiveAnalyzer<F extends BaseElementForest<E>,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	IncludeExcludeTreeFilter<E extends Element<E>>	A tree filter that uses a combination of an include and exclude filters to arrive at the filtering decisions.
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.
class	OverridableIncludeExcludeTreeFilter<E extends Element<E>>	This is similar to the IncludeExcludeTreeFilter but adds support for the "include inside exclude", e.g.

Classes in org.revapi.base that implement Element

Modifier and Type	Class	Description
class	BaseElement<E extends Element<E>>	A base class for API elements.

Methods in org.revapi.base with type parameters of type Element

Modifier and Type	Method	Description
<E extends Element<E>> Optional<TreeFilter<E>>	BaseTreeFilterProvider.filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
<T extends Element<E>> Iterator<T>	BaseElement.iterateOverChildren(Class<T> resultType, boolean recurse, Filter<? super T> filter)
protected <T extends Element<E>> void	BaseElementForest.search(List<T> results, Class<T> resultType, SortedSet<E> siblings, boolean recurse, TreeFilter<E> filter)
<T extends Element<E>> List<T>	BaseElement.searchChildren(Class<T> resultType, boolean recurse, Filter<? super T> filter)
<T extends Element<E>> void	BaseElement.searchChildren(List<T> results, Class<T> resultType, boolean recurse, Filter<? super T> filter)
<T extends Element<E>> Stream<T>	BaseElementForest.stream(Class<T> resultType, boolean recurse, TreeFilter<E> filter, Element<E> root)

Methods in org.revapi.base with parameters of type Element

Modifier and Type	Method	Description
<T extends Element<E>> Stream<T>	BaseElementForest.stream(Class<T> resultType, boolean recurse, TreeFilter<E> filter, Element<E> root)

Uses of Element in org.revapi.query

Classes in org.revapi.query with type parameters of type Element

Modifier and Type	Class	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 parameters in org.revapi.query with type arguments of type Element

Constructor	Description
DFSFilteringIterator(Iterator<? extends Element> rootIterator, Class<? extends E> resultClass, Filter<? super E> filter)	Deprecated. Constructor.

Uses of Element in org.revapi.simple

Classes in org.revapi.simple with type parameters of type Element

Modifier and Type	Class	Description
class	SimpleDifferenceTransform<T extends Element<T>>	Deprecated. use BaseDifferenceTransform instead

Classes in org.revapi.simple that implement Element

Modifier and Type	Class	Description
class	SimpleElement	Deprecated. use BaseElement instead

Methods in org.revapi.simple with type parameters of type Element

Modifier and Type	Method	Description
protected <T extends Element> List<T>	SimpleElement.getDirectChildrenOfType(Class<T> type)	Deprecated.
<T extends Element> List<T>	SimpleElementForest.search(Class<T> resultType, boolean recurse, TreeFilter filter, Element root)	Deprecated.
<T extends Element> void	SimpleElementForest.search(List<T> results, Class<T> resultType, SortedSet<? extends Element> currentLevel, boolean recurse, Filter<? super T> filter)	Deprecated.
<T extends Element> void	SimpleElementForest.search(List<T> results, Class<T> resultType, SortedSet<? extends Element> currentLevel, boolean recurse, TreeFilter filter)	Deprecated.

Methods in org.revapi.simple that return Element

Modifier and Type	Method	Description
Element	SimpleElement.getParent()	Deprecated.

Methods in org.revapi.simple that return types with arguments of type Element

Modifier and Type	Method	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.

Methods in org.revapi.simple with parameters of type Element

Modifier and Type	Method	Description
boolean	SimpleElementFilter.applies(Element<?> element)	Deprecated.
<T extends Element> List<T>	SimpleElementForest.search(Class<T> resultType, boolean recurse, TreeFilter filter, Element root)	Deprecated.
void	SimpleElement.setParent(Element parent)	Deprecated. Sets the parent element.
Stream	SimpleElementForest.stream(Class resultType, boolean recurse, TreeFilter filter, Element root)	Deprecated.

Method parameters in org.revapi.simple with type arguments of type Element

Modifier and Type	Method	Description
<T extends Element> void	SimpleElementForest.search(List<T> results, Class<T> resultType, SortedSet<? extends Element> currentLevel, boolean recurse, Filter<? super T> filter)	Deprecated.
<T extends Element> void	SimpleElementForest.search(List<T> results, Class<T> resultType, SortedSet<? extends Element> currentLevel, boolean recurse, TreeFilter filter)	Deprecated.