Package com.intellij.structuralsearch.impl.matcher.handlers

Class MatchingHandler

java.lang.Object

com.intellij.structuralsearch.impl.matcher.handlers.MatchingHandler

Direct Known Subclasses:

AnnotationHandler, DeclarationStatementHandler, DocDataHandler, ExpressionHandler, LightTopLevelMatchingHandler, LiteralWithSubstitutionHandler, SimpleHandler, SkippingHandler, StatementHandler, SubstitutionHandler, SymbolHandler, TopLevelMatchingHandler, TypedSymbolHandler

public abstract class MatchingHandler
extends java.lang.Object

Root of handlers for pattern node matching. Handles simplest type of the match.

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.intellij.structuralsearch.impl.matcher.handlers.MatchingHandler.ClearStateVisitor	clearingVisitor
protected NodeFilter	filter

Constructor Summary

Constructors

Constructor and Description
MatchingHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canMatch(PsiElement patternNode, PsiElement matchedNode, MatchContext context)
NodeFilter	getFilter()
PsiElement	getPinnedNode()
protected boolean	isMatchSequentiallySucceeded(NodeIterator matchNodes)
boolean	match(PsiElement patternNode, PsiElement matchedNode, MatchContext context) Matches given handler node against given value.
boolean	matchInAnyOrder(NodeIterator patternNodes, NodeIterator matchedNodes, MatchContext context)
boolean	matchSequentially(NodeIterator patternNodes, NodeIterator matchNodes, MatchContext context)
void	reset()
void	setFilter(NodeFilter filter)
void	setPinnedElement(PsiElement pinnedElement)
boolean	shouldAdvanceTheMatchFor(PsiElement patternElement, PsiElement matchedElement)
boolean	shouldAdvanceThePatternFor(PsiElement patternElement, PsiElement matchedElement)
protected static boolean	validateSatisfactionOfHandlers(NodeIterator patternNodes, MatchContext context)

Methods inherited from class java.lang.Object

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

Field Detail

filter

protected NodeFilter filter

clearingVisitor

protected static com.intellij.structuralsearch.impl.matcher.handlers.MatchingHandler.ClearStateVisitor clearingVisitor

Constructor Detail

MatchingHandler

public MatchingHandler()

Method Detail

setFilter

public void setFilter(NodeFilter filter)

match

public boolean match(PsiElement patternNode,
                     PsiElement matchedNode,
                     MatchContext context)

Matches given handler node against given value.

Parameters:

matchedNode - for matching

context - of the matching

Returns:

true if matching was successful and false otherwise

canMatch

public boolean canMatch(PsiElement patternNode,
                        PsiElement matchedNode,
                        MatchContext context)

matchSequentially

public boolean matchSequentially(NodeIterator patternNodes,
                                 NodeIterator matchNodes,
                                 MatchContext context)

isMatchSequentiallySucceeded

protected boolean isMatchSequentiallySucceeded(NodeIterator matchNodes)

matchInAnyOrder

public boolean matchInAnyOrder(NodeIterator patternNodes,
                               NodeIterator matchedNodes,
                               MatchContext context)

validateSatisfactionOfHandlers

protected static boolean validateSatisfactionOfHandlers(NodeIterator patternNodes,
                                                        MatchContext context)

getFilter

public NodeFilter getFilter()

shouldAdvanceThePatternFor

public boolean shouldAdvanceThePatternFor(PsiElement patternElement,
                                          PsiElement matchedElement)

shouldAdvanceTheMatchFor

public boolean shouldAdvanceTheMatchFor(PsiElement patternElement,
                                        PsiElement matchedElement)

reset

public void reset()

getPinnedNode

public PsiElement getPinnedNode()

setPinnedElement

public void setPinnedElement(PsiElement pinnedElement)