Package org.revapi
Interface ElementFilter
-
- All Superinterfaces:
AutoCloseable
,Configurable
,Filter<Element<?>>
,TreeFilterProvider
- All Known Implementing Classes:
SimpleElementFilter
@Deprecated public interface ElementFilter extends TreeFilterProvider, Filter<Element<?>>, AutoCloseable, Configurable
Deprecated.useTreeFilterProvider
insteadAn element filter is a type of extension that can serve as an input filter on the element forest.Once the
ElementForest
is produced by anArchiveAnalyzer
, the registered element filters will be called to potentially leave out certain elements from the API analysis.An example of this might be leaving out certain packages from the analysis of java archives.
The
AutoCloseable.close()
is not called if there is no prior call toConfigurable.initialize(AnalysisContext)
. Do all your resource acquisition in initialize, not during the construction of the object.- Since:
- 0.1
- Author:
- Lukas Krejci
-
-
Method Summary
All Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description default <E extends Element<E>>
Optional<TreeFilter<E>>filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
Deprecated.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
-
Methods inherited from interface org.revapi.query.Filter
applies, shouldDescendInto
-
-
-
-
Method Detail
-
filterFor
default <E extends Element<E>> Optional<TreeFilter<E>> filterFor(ArchiveAnalyzer<E> archiveAnalyzer)
Deprecated.Description copied from interface:TreeFilterProvider
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.- Specified by:
filterFor
in interfaceTreeFilterProvider
- 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
-
-