spoon.reflect.visitor.filter

Class SubInheritanceHierarchyFunction

java.lang.Object

spoon.reflect.visitor.filter.SubInheritanceHierarchyFunction

All Implemented Interfaces:

CtConsumableFunction<CtTypeInformation>, CtQueryAware

public class SubInheritanceHierarchyFunction
extends java.lang.Object
implements CtConsumableFunction<CtTypeInformation>, CtQueryAware

Expects a CtTypeInformation as input and produces all sub classes and sub interfaces recursively.
The output is produced in arbitrary order.

Constructor Summary

Constructors

Constructor and Description
SubInheritanceHierarchyFunction() The mapping function created using this constructor will visit each sub class and sub interface following sub hierarchy.

Method Summary

Modifier and Type	Method and Description
void	apply(CtTypeInformation input, CtConsumer<java.lang.Object> outputConsumer) Evaluates the function on the given input.
SubInheritanceHierarchyFunction	failOnClassNotFound(boolean failOnClassNotFound)
SubInheritanceHierarchyFunction	includingInterfaces(boolean includingInterfaces)
SubInheritanceHierarchyFunction	includingSelf(boolean includingSelf)
void	setQuery(CtQuery query) This method is called when the filter/function is added as a step to a CtQuery by the query engine (CtQueryImpl).

Methods inherited from class java.lang.Object

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

Constructor Detail

SubInheritanceHierarchyFunction

public SubInheritanceHierarchyFunction()

The mapping function created using this constructor will visit each sub class and sub interface following sub hierarchy.

Method Detail

includingSelf

public SubInheritanceHierarchyFunction includingSelf(boolean includingSelf)

Parameters:

includingSelf - if true then input element is sent to output too. By default it is false.

includingInterfaces

public SubInheritanceHierarchyFunction includingInterfaces(boolean includingInterfaces)

Parameters:

includingInterfaces - if false then interfaces are not visited - only super classes. By default it is true.

failOnClassNotFound

public SubInheritanceHierarchyFunction failOnClassNotFound(boolean failOnClassNotFound)

Parameters:

failOnClassNotFound - sets whether processing should throw an exception if class is missing in noClassPath mode

apply

public void apply(CtTypeInformation input,
                  CtConsumer<java.lang.Object> outputConsumer)

Description copied from interface: CtConsumableFunction

Evaluates the function on the given input.

Specified by:

apply in interface CtConsumableFunction<CtTypeInformation>

Parameters:

input - the input of the function

outputConsumer - the consumer which accepts the results of this function.

setQuery

public void setQuery(CtQuery query)

Description copied from interface: CtQueryAware

This method is called when the filter/function is added as a step to a CtQuery by the query engine (CtQueryImpl).

Specified by:

setQuery in interface CtQueryAware

Parameters:

query - an instance registering this function/filter.