org.revapi.simple

Class SimpleElementFilter

java.lang.Object

org.revapi.simple.SimpleConfigurable

org.revapi.simple.SimpleElementFilter

All Implemented Interfaces:

AutoCloseable, Configurable, ElementFilter, Filter<Element>

public abstract class SimpleElementFilter
extends SimpleConfigurable
implements ElementFilter

Since:

0.4.0

Author:

Lukas Krejci

Constructor Summary

Constructors

Constructor and Description
SimpleElementFilter()

Method Summary

Modifier and Type	Method and Description
boolean	applies(Element element) If an element in a forest is of compatible type, does the filter apply to it?
boolean	shouldDescendInto(Object element) Should the forest traversal descend into the provided element? It is not guaranteed that the element is of the type required by this parameter, but its children might be.

Methods inherited from class org.revapi.simple.SimpleConfigurable

close, getJSONSchema, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.revapi.configuration.Configurable

getExtensionId, getJSONSchema, initialize

Constructor Detail

SimpleElementFilter

public SimpleElementFilter()

Method Detail

applies

public boolean applies(@Nullable
                       Element element)

Description copied from interface: Filter

If an element in a forest is of compatible type, does the filter apply to it?

Specified by:

applies in interface Filter<Element>

Parameters:

element - the element in the forest

Returns:

true if the filter applies, false otherwise

shouldDescendInto

public boolean shouldDescendInto(@Nullable
                                 Object element)

Description copied from interface: Filter

Should the forest traversal descend into the provided element? It is not guaranteed that the element is of the type required by this parameter, but its children might be.

Therefore the filter is given a chance to influence the decision even for elements of types that it is not declared to filter.

Specified by:

shouldDescendInto in interface Filter<Element>

Parameters:

element - the element to be descended into

Returns:

true if forest traversal should descend into the element, false otherwise