INRIA/spoon — documented rules

Concretely, this is translated as an interface CtInvocation ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/code/CtInvocation.html)) inheriting from both interfaces CtStatement and CtExpression.

This class exposes an API to get the content CtComment.getContent(), the type CtComment.getCommentType() and the position CtComment.getPosition() of a comment.

This class exposes an API to get the content CtComment.getContent(), the type CtComment.getCommentType() and the position CtComment.getPosition() of a comment.

This class exposes an API to get the content CtComment.getContent(), the type CtComment.getCommentType() and the position CtComment.getPosition() of a comment.

You can retrieve the comments of each CtElement via the API CtElement.getComments() which returns a List<CtComment>.

The Javadoc comments are also available via the API CtElement.getDocComment() but this API returns directly the content of the Javadoc as String.

The idea is to configure DefaultJavaPrettyPrinter with an appropriate TokenWriter.

A Filter defines a predicate of the form of a matches method that returns true if an element has to be selected in the filtering operation.

A Filter is given as parameter to CtElement#getElement(Filter) (or CtQueryable#filterChildren(Filter)) which implements a depth-first search algorithm.

A Filter is given as parameter to CtElement#getElement(Filter) (or CtQueryable#filterChildren(Filter)) which implements a depth-first search algorithm.

EarlyTerminatingScanner is a specialized Class implementing CtScanner that stops once terminate() has been called.

CtQueryable#map(CtFunction)enables you to give Java 8 lambda as query.

CtQueryable#map(CtFunction)enables you to give Java 8 lambda as query.

**Compatibility with existing filters** CtQueryable#filterChildren(Filter) is a filtering query that can be chained:

Method setInput allows you to reuse the same query over multiple inputs.

In such case it makes sense to create unbound query using Factory#createQuery().

Each example above use CtQuery#list() to evaluate the query.

There is CtQuery#forEach(CtConsumer), which sends each query result to the CtConsumer#accept function.

There is CtQuery#forEach(CtConsumer), which sends each query result to the CtConsumer#accept function.

There is CtQuery#forEach(CtConsumer), which sends each query result to the CtConsumer#accept function.

Finally there is CtQuery#first(), which evaluates the query until first query result is found.

**Warning** The JarLauncher feature (and all features relying on decompilation) are not included in spoon-core but in spoon-decompiler.

instantiate TemplateMatcher and call method find or use it as Filter of a query.

See roleToSkippedClass in class [ElementNode](https://github.com/INRIA/spoon/blob/master/src/main/java/spoon/pattern/internal/node/ElementNode.java)

CtPath ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/path/CtPath.html)) defines the path to a CtElement ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/declaration/CtElement.html)) in a model, similarly to XPath for XML.

Method getPath in CtElement returns a path

name(String, String[]) ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/path/CtPathBuilder.html#name-java.lang.String-java.lang.String:A...-)) adds a name matcher to the current path.

type(Class, String[]) ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/path/CtPathBuilder.html#type-java.lang.Class-java.lang.String:A...-)) matches on element of a given type.

role(CtPathRole, String[]) ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/path/CtPathBuilder.html#role-spoon.reflect.path.CtPathRole-java.lang.String:A...-)) matches on elements by their role (where CtPathRole gives all constants supported).

wildcard() ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/path/CtPathBuilder.html#wildcard--)) matches only on elements child of current one.

recursiveWildcard() ([javadoc](http://spoon.gforge.inria.fr/mvnsites/spoon-core/apidocs/spoon/reflect/path/CtPathBuilder.html#recursiveWildcard--)) matches on any child and sub-children.

The main methods are getMatchingElement and getMatchingElements.

The main methods are getMatchingElement and getMatchingElements.

To this end, Spoon provides a special kind of processor called AnnotationProcessor whose interface is:

The process method (line 4) receives as arguments both the CtElement and the annotation it carries.

The remaining four methods (getProcessedAnnotationTypes, getConsumedAnnotationTypes, inferConsumedAnnotationTypes and shouldBeConsumed) configure the visiting of the AST during annotation processing.

The remaining four methods (getProcessedAnnotationTypes, getConsumedAnnotationTypes, inferConsumedAnnotationTypes and shouldBeConsumed) configure the visiting of the AST during annotation processing.

The remaining four methods (getProcessedAnnotationTypes, getConsumedAnnotationTypes, inferConsumedAnnotationTypes and shouldBeConsumed) configure the visiting of the AST during annotation processing.

A template parameter has a special method (named S, for Substitution) that is used as a marker to indicate the places where a template parameter substitution should occur.

For a CtExpression, method S() returns the return type of the expression.

All methods in this class are named assertThat and take only one argument.