org.revapi.basic

Class ConfigurableElementFilter

java.lang.Object

org.revapi.basic.ConfigurableElementFilter

All Implemented Interfaces:

AutoCloseable, org.revapi.configuration.Configurable, org.revapi.ElementFilter, org.revapi.query.Filter<org.revapi.Element>

public class ConfigurableElementFilter
extends Object
implements org.revapi.ElementFilter

An element filter that can filter out elements based on matching their full human readable representations. Archive filter can filter out elements that belong to specified archives.

The configuration looks like follows:

 {
      "revapi" : {
          "filter" : {
              "elements" : {
                  "include" : ["REGEX_ON_ELEMENT_FULL_REPRESENTATIONS", "ANOTHER_REGEX_ON_ELEMENT_FULL_REPRESENTATIONS"],
                  "exclude" : ["REGEX_ON_ELEMENT_FULL_REPRESENTATIONS", "ANOTHER_REGEX_ON_ELEMENT_FULL_REPRESENTATIONS"]
              },
              "archives" : {
                  "include" : ["REGEX_ON_ARCHIVE_NAMES", "ANOTHER_REGEX_ON_ARCHIVE_NAMES"],
                  "exclude" : ["REGEX_ON_ARCHIVE_NAMES", "ANOTHER_REGEX_ON_ARCHIVE_NAMES"]
              }
          }
      }
 }
 

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

Modifier and Type	Method and Description
boolean	applies(org.revapi.Element element)
void	close()
String[]	getConfigurationRootPaths()
Reader	getJSONSchema(String configurationRootPath)
void	initialize(org.revapi.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 org.revapi.configuration.Configurable

getJSONSchema

@Nullable
public Reader getJSONSchema(@Nonnull
                                      String configurationRootPath)

Specified by:

getJSONSchema in interface org.revapi.configuration.Configurable

initialize

public void initialize(@Nonnull
                       org.revapi.AnalysisContext analysisContext)

Specified by:

initialize in interface org.revapi.configuration.Configurable

applies

public boolean applies(@Nullable
                       org.revapi.Element element)

Specified by:

applies in interface org.revapi.query.Filter<org.revapi.Element>

shouldDescendInto

public boolean shouldDescendInto(@Nullable
                                 Object element)

Specified by:

shouldDescendInto in interface org.revapi.query.Filter<org.revapi.Element>

close

public void close()

Specified by:

close in interface AutoCloseable