org.revapi.basic

Class ConfigurableElementFilter

java.lang.Object

org.revapi.basic.ConfigurableElementFilter

All Implemented Interfaces:

AutoCloseable, Configurable, ElementFilter, Filter<Element>

public class ConfigurableElementFilter
extends Object
implements ElementFilter

An element filter that can filter out elements based on matching their full human readable representations. The configuration looks like follows:

 {
      "revapi" : {
          "filter" : {
              "include" : ["REGEX_ON_ELEMENT_FULL_REPRESENTATIONS", "ANOTHER_REGEX_ON_ELEMENT_FULL_REPRESENTATIONS"],
              "exclude" : ["REGEX_ON_ELEMENT_FULL_REPRESENTATIONS", "ANOTHER_REGEX_ON_ELEMENT_FULL_REPRESENTATIONS"]
          }
      }
 }
 

If no include or exclude filters are defined, everything is included. If at least 1 include filter is defined, only elements matching it are included. Out of the included elements, some may be further excluded by the exclude filters.

Since:

0.1

Author:

Lukas Krejci

Constructor Summary

Constructors

Constructor and Description
ConfigurableElementFilter()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	applies(Element element)
void	close()
String[]	getConfigurationRootPaths()
Reader	getJSONSchema(String configurationRootPath)
void	initialize(AnalysisContext analysisContext)
boolean	shouldDescendInto(Object element)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurableElementFilter

public ConfigurableElementFilter()

Method Detail

getConfigurationRootPaths

@Nullable
public String[] getConfigurationRootPaths()

Specified by:

getConfigurationRootPaths in interface Configurable

getJSONSchema

@Nullable
public Reader getJSONSchema(@Nonnull
                            String configurationRootPath)

Specified by:

getJSONSchema in interface Configurable

initialize

public void initialize(@Nonnull
              AnalysisContext analysisContext)

Specified by:

initialize in interface Configurable

applies

public boolean applies(@Nullable
              Element element)

Specified by:

applies in interface Filter<Element>

shouldDescendInto

public boolean shouldDescendInto(@Nullable
                        Object element)

Specified by:

shouldDescendInto in interface Filter<Element>

close

public void close()

Specified by:

close in interface AutoCloseable