org.netbeans.api.java.source.matching

Class Occurrence

java.lang.Object

org.netbeans.api.java.source.matching.Occurrence

public final class Occurrence
extends Object

A found occurrence of a pattern.

Method Summary

Modifier and Type	Method and Description
Map<String,Collection<? extends TreePath>>	getMultiVariables() For patterns with free variables, contains mapping of multi-variable names to the tree nodes that were bound to the variable.
TreePath	getOccurrenceRoot() The tree node that represents the occurrence.
Map<String,TreePath>	getVariables() For patterns with free variables, contains mapping of single-variable names to the tree node that was bound to the variable.
Map<String,String>	getVariables2Names() For patterns with free variables, contains mapping of variable names to a name that was bound to the variable.
Map<Element,Element>	getVariablesRemapToElement() For patterns which allow variable remap, contains mapping of the element in the pattern to the corresponding element in this occurrence.
Map<Element,TreePath>	getVariablesRemapToTrees() For patterns which allow variable remap to trees, contains mapping of the element in the pattern to the corresponding tree node in this occurrence.

Methods inherited from class java.lang.Object

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

Method Detail

getOccurrenceRoot

public TreePath getOccurrenceRoot()

The tree node that represents the occurrence. For multi-part patterns Pattern.createSimplePattern(java.lang.Iterable), returns the TreePath corresponding to the first part (TODO: verify!).

Returns:

root tree of the occurrence

getVariables

public Map<String,TreePath> getVariables()

For patterns with free variables, contains mapping of single-variable names to the tree node that was bound to the variable. That means, the tree node that corresponds to the first occurrence of the variable in the pattern.

Returns:

mapping of free variable names to the tree nodes that were bound to them

getMultiVariables

public Map<String,Collection<? extends TreePath>> getMultiVariables()

For patterns with free variables, contains mapping of multi-variable names to the tree nodes that were bound to the variable. That means, the tree nodes that corresponds to the first occurrence of the variable in the pattern.

Returns:

mapping of free variable names to the tree nodes that were bound to them

getVariables2Names

public Map<String,String> getVariables2Names()

For patterns with free variables, contains mapping of variable names to a name that was bound to the variable.

Returns:

mapping of free variable names to names that were bound to them

getVariablesRemapToElement

public Map<Element,Element> getVariablesRemapToElement()

For patterns which allow variable remap, contains mapping of the element in the pattern to the corresponding element in this occurrence.

Returns:

mapping of elements in the pattern to the elements in this occurrence

getVariablesRemapToTrees

public Map<Element,TreePath> getVariablesRemapToTrees()

For patterns which allow variable remap to trees, contains mapping of the element in the pattern to the corresponding tree node in this occurrence.

Returns:

mapping of elements in the pattern to the elements in this occurrence