org.revapi

Interface ElementForest

All Known Implementing Classes:

SimpleElementForest

public interface ElementForest

A representation of some "unit" understood by an API analyzer. Typically an abstract syntax tree of a language.

Since:

0.1

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
API	getApi()
SortedSet<? extends Element>	getRoots() A sorted set of all root elements of the forest.
<T extends Element> List<T>	search(Class<T> resultType, boolean recurse, Filter<? super T> filter, Element searchRoot) Searches through the forest for elements of given type, potentially further filtering.

Method Detail

getApi

@Nonnull
API getApi()

Returns:

the API this forest represents

getRoots

@Nonnull
SortedSet<? extends Element> getRoots()

A sorted set of all root elements of the forest. The set uses the natural order of the element implementations.

Returns:

the roots elements of the forest.

search

@Nonnull
<T extends Element> List<T> search(@Nonnull
                                            Class<T> resultType,
                                            boolean recurse,
                                            @Nullable
                                            Filter<? super T> filter,
                                            @Nullable
                                            Element searchRoot)

Searches through the forest for elements of given type, potentially further filtering.

If the searchRoot is not null, this is technically equivalent to calling the Element.searchChildren(java.lang.Class, boolean, org.revapi.query.Filter) on the searchRoot.

Type Parameters:

T - the type of the elements to look for

Parameters:

resultType - the type of the elements to be contained in the results

recurse - false to only search direct children, true for searching recursively

filter - the optional filter

searchRoot - optional element from which to conduct the search

Returns:

a list of elements of given type (or any subtype) from the forest, filtered by the filter if provided