Package org.revapi
Interface TreeFilterProvider
-
- All Superinterfaces:
AutoCloseable
,Configurable
- All Known Subinterfaces:
ElementFilter
- All Known Implementing Classes:
BaseTreeFilterProvider
,SimpleElementFilter
public interface TreeFilterProvider extends Configurable, AutoCloseable
Forest filter helps theArchiveAnalyzer
filter the resulting element forest while it is being created.It is guaranteed that the elements will be called in an hierarchical order, e.g. parents will be filtered before their children.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <E extends Element<E>>
Optional<TreeFilter<E>>filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
Creates a new filter specifically for use with the provided analyzer.-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface org.revapi.configuration.Configurable
getExtensionId, getJSONSchema, initialize
-
-
-
-
Method Detail
-
filterFor
<E extends Element<E>> Optional<TreeFilter<E>> filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
Creates a new filter specifically for use with the provided analyzer. Can return null if this forest filter cannot understand elements provided by the analyzer.- Parameters:
archiveAnalyzer
- the archive analyzer to produce a new filter for- Returns:
- a new filter for given analyzer or empty if this forest filter is not compatible with the analyzer
-
-