Package com.intellij.structuralsearch.impl.matcher

Class GlobalMatchingVisitor

java.lang.Object

com.intellij.dupLocator.AbstractMatchingVisitor

com.intellij.structuralsearch.impl.matcher.GlobalMatchingVisitor

public class GlobalMatchingVisitor
extends AbstractMatchingVisitor

Visitor class to manage pattern matching

Field Summary

Fields

Modifier and Type	Field and Description
static Key<java.util.List<? extends PsiElement>>	UNMATCHED_ELEMENTS_KEY

Constructor Summary

Constructors

Constructor and Description
GlobalMatchingVisitor()

Method Summary

Modifier and Type	Method and Description
boolean	allowsAbsenceOfMatch(PsiElement element)
protected boolean	doMatchInAnyOrder(NodeIterator elements, NodeIterator elements2)
PsiElement	getElement()
MatchContext	getMatchContext()
protected NodeFilter	getNodeFilter()
boolean	getResult()
boolean	handleTypedElement(PsiElement typedElement, PsiElement match)
boolean	isLeftLooseMatching()
boolean	isRightLooseMatching()
boolean	match(PsiElement el1, PsiElement el2) Identifies the match between given element of program tree and pattern element
void	matchContext(NodeIterator elements) Descents the tree in depth finding matches
boolean	matchOptionally(PsiElement patternNode, PsiElement matchNode)
boolean	matchSequentially(NodeIterator patternNodes, NodeIterator matchNodes) Matches tree segments starting with given elements to find equality
boolean	matchText(PsiElement left, PsiElement right)
boolean	matchText(java.lang.String left, java.lang.String right)
void	scopeMatch(PsiElement patternNode, boolean typedVar, PsiElement matchNode)
void	setMatchContext(MatchContext matchContext)
boolean	setResult(boolean result)

Methods inherited from class com.intellij.dupLocator.AbstractMatchingVisitor

matchInAnyOrder, matchInAnyOrder, matchOptionally, matchSequentially, matchSequentially, matchSequentiallyOptionally, matchSons, matchSonsInAnyOrder, matchSonsOptionally

Methods inherited from class java.lang.Object

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

Field Detail

UNMATCHED_ELEMENTS_KEY

public static final Key<java.util.List<? extends PsiElement>> UNMATCHED_ELEMENTS_KEY

Constructor Detail

GlobalMatchingVisitor

public GlobalMatchingVisitor()

Method Detail

getElement

public PsiElement getElement()

getResult

public boolean getResult()

setResult

public boolean setResult(boolean result)

getMatchContext

public MatchContext getMatchContext()

doMatchInAnyOrder

protected boolean doMatchInAnyOrder(NodeIterator elements,
                                    NodeIterator elements2)

Specified by:

doMatchInAnyOrder in class AbstractMatchingVisitor

matchOptionally

public boolean matchOptionally(PsiElement patternNode,
                               PsiElement matchNode)

Overrides:

matchOptionally in class AbstractMatchingVisitor

getNodeFilter

protected NodeFilter getNodeFilter()

Specified by:

getNodeFilter in class AbstractMatchingVisitor

handleTypedElement

public final boolean handleTypedElement(PsiElement typedElement,
                                        PsiElement match)

allowsAbsenceOfMatch

public boolean allowsAbsenceOfMatch(PsiElement element)

match

public boolean match(PsiElement el1,
                     PsiElement el2)

Identifies the match between given element of program tree and pattern element

Specified by:

match in class AbstractMatchingVisitor

Parameters:

el1 - the pattern for matching

el2 - the tree element for matching

Returns:

true if equal and false otherwise

matchSequentially

public boolean matchSequentially(NodeIterator patternNodes,
                                 NodeIterator matchNodes)

Matches tree segments starting with given elements to find equality

Specified by:

matchSequentially in class AbstractMatchingVisitor

Parameters:

patternNodes - the pattern element for matching

matchNodes - the tree element for matching

Returns:

if they are equal and false otherwise

matchContext

public void matchContext(NodeIterator elements)

Descents the tree in depth finding matches

Parameters:

elements - the element for which the sons are looked for match

setMatchContext

public void setMatchContext(MatchContext matchContext)

isLeftLooseMatching

public boolean isLeftLooseMatching()

Overrides:

isLeftLooseMatching in class AbstractMatchingVisitor

isRightLooseMatching

public boolean isRightLooseMatching()

Overrides:

isRightLooseMatching in class AbstractMatchingVisitor

matchText

public boolean matchText(PsiElement left,
                         PsiElement right)

matchText

public boolean matchText(java.lang.String left,
                         java.lang.String right)

scopeMatch

public void scopeMatch(PsiElement patternNode,
                       boolean typedVar,
                       PsiElement matchNode)