org.netbeans.api.java.source.matching

Class Matcher

java.lang.Object

org.netbeans.api.java.source.matching.Matcher

All Implemented Interfaces:

Cancellable

public class Matcher
extends Object
implements Cancellable

Searches for occurrences of a Pattern.

Method Summary

Modifier and Type	Method and Description
boolean	cancel()
static Matcher	create(CompilationInfo info) Create the Matcher for the given CompilationInfo.
Collection<? extends Occurrence>	match(Pattern pattern) Search for occurrences of the given pattern in the given subject tree.
Matcher	setCancel(AtomicBoolean cancel) Make the matching cancelable by setting true to the given AtomicBoolean.
Matcher	setKeepSyntheticTrees() When set, trees (like implicit receivers) that are not in the source code, but have variable in the pattern, will get a synthetic entry in variables.
Matcher	setPresetVariable(Map<String,TreePath> variables, Map<String,Collection<? extends TreePath>> multiVariables, Map<String,String> variables2Names) Preset values of free variables in the pattern (see Pattern.createPatternWithFreeVariables(com.sun.source.util.TreePath, java.util.Map)).
Matcher	setSearchRoot(TreePath root) Search for the occurrences only under the given tree.
Matcher	setTreeTopSearch() The matcher should perform the tree-top search: the occurrence of the pattern must correspond directly to the search root.
Matcher	setUntypedMatching() The matching should ignore type attributes on the trees.

Methods inherited from class java.lang.Object

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

Method Detail

create

@NonNull
public static Matcher create(@NonNull
                                      CompilationInfo info)

Create the Matcher for the given CompilationInfo. See the set methods for default settings of the Matcher.

Parameters:

info - for which the Matcher should be created

Returns:

newly created Matcher

setSearchRoot

@NonNull
public Matcher setSearchRoot(@NonNull
                                      TreePath root)

Search for the occurrences only under the given tree. By default, the full CompilationUnitTree of the given CompilationInfo is used.

Parameters:

root - where to start the search

Returns:

the matcher itself

setTreeTopSearch

@NonNull
public Matcher setTreeTopSearch()

The matcher should perform the tree-top search: the occurrence of the pattern must correspond directly to the search root. By default, tree-top search is not performed, and all occurrences of the pattern under the specified root will be reported.

Returns:

the matcher itself

setUntypedMatching

@NonNull
public Matcher setUntypedMatching()

The matching should ignore type attributes on the trees. By default, types specified in the pattern must match the actual types.

Returns:

the matcher itself

setKeepSyntheticTrees

@NonNull
public Matcher setKeepSyntheticTrees()

When set, trees (like implicit receivers) that are not in the source code, but have variable in the pattern, will get a synthetic entry in variables.

Returns:

the matcher itself

Since:

2.40

setPresetVariable

@NonNull
public Matcher setPresetVariable(@NonNull
                                          Map<String,TreePath> variables,
                                          @NonNull
                                          Map<String,Collection<? extends TreePath>> multiVariables,
                                          @NonNull
                                          Map<String,String> variables2Names)

Preset values of free variables in the pattern (see Pattern.createPatternWithFreeVariables(com.sun.source.util.TreePath, java.util.Map)). A tree node will be marked as an occurrence of the pattern only if the subtree corresponding to a specified free variable will match the given value. By default, no values are preset for any variables.

Parameters:

variables -

multiVariables -

variables2Names -

Returns:

the matcher itself

setCancel

@NonNull
public Matcher setCancel(@NonNull
                                  AtomicBoolean cancel)

Make the matching cancelable by setting true to the given AtomicBoolean.

Parameters:

cancel - AtomicBoolean which should be set to true to stop the matching as soon as possible

Returns:

the matcher itself

match

@NonNull
public Collection<? extends Occurrence> match(Pattern pattern)

Search for occurrences of the given pattern in the given subject tree. TODO: "multipattern" matching

Parameters:

pattern - for which the search should be performed

Returns:

descriptions of found pattern occurrences

cancel

public boolean cancel()

Specified by:

cancel in interface Cancellable