org.revapi.query

Interface Filter<T>

All Known Subinterfaces:

ElementFilter

All Known Implementing Classes:

SimpleElementFilter

public interface Filter<T>

A basic filter designed to work with element forests.

Since:

0.1

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
boolean	applies(T 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.

Method Detail

applies

boolean applies(@Nullable
                T element)

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

Parameters:

element - the element in the forest

Returns:

true if the filter applies, false otherwise

shouldDescendInto

boolean shouldDescendInto(@Nullable
                          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.

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

Parameters:

element - the element to be descended into

Returns:

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