Package com.intellij.structuralsearch

Class JavaStructuralSearchProfile

java.lang.Object

com.intellij.structuralsearch.StructuralSearchProfile

com.intellij.structuralsearch.JavaStructuralSearchProfile

public class JavaStructuralSearchProfile
extends StructuralSearchProfile

Field Summary

Fields

Modifier and Type	Field and Description
static PatternContext	DEFAULT_CONTEXT
static PatternContext	MEMBER_CONTEXT

Fields inherited from class com.intellij.structuralsearch.StructuralSearchProfile

EP_NAME, PATTERN_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
JavaStructuralSearchProfile()

Method Summary

Modifier and Type	Method and Description
void	checkReplacementPattern(Project project, ReplaceOptions options)
void	checkSearchPattern(CompiledPattern pattern)
void	compile(PsiElement[] elements, GlobalCompilingVisitor globalVisitor)
PsiCodeFragment	createCodeFragment(Project project, java.lang.String text, java.lang.String contextId)
CompiledPattern	createCompiledPattern()
PsiElementVisitor	createMatchingVisitor(GlobalMatchingVisitor globalVisitor)
PsiElement []	createPatternTree(java.lang.String text, PatternTreeContext context, LanguageFileType fileType, Language language, java.lang.String contextId, Project project, boolean physical)
PsiElement	extendMatchedByDownUp(PsiElement targetNode)
PsiElement	extendMatchOnePsiFile(PsiElement file)
java.lang.String	getAlternativeText(PsiElement node, java.lang.String previousText)
java.lang.String	getCodeFragmentText(PsiFile fragment) This method is called while holding a read action.
java.util.List<MatchPredicate>	getCustomPredicates(MatchVariableConstraint constraint, java.lang.String name, MatchOptions options)
LanguageFileType	getDefaultFileType(LanguageFileType currentDefaultFileType)
NodeFilter	getLexicalNodesFilter()
java.lang.String	getMeaningfulText(PsiElement element)
java.util.List<PatternContext>	getPatternContexts()
Configuration[]	getPredefinedTemplates()
PsiElement	getPresentableElement(PsiElement element)
StructuralReplaceHandler	getReplaceHandler(Project project, ReplaceOptions replaceOptions)
java.util.Collection<java.lang.String>	getReservedWords()
java.lang.Class<? extends TemplateContextType>	getTemplateContextTypeClass()
java.lang.String	getText(PsiElement match, int start, int end)
java.lang.String	getTypedVarString(PsiElement element)
void	handleNoSubstitution(ParameterInfo info, java.lang.StringBuilder result)
void	handleSubstitution(ParameterInfo info, MatchResult match, java.lang.StringBuilder result, ReplacementInfo replacementInfo)
boolean	isApplicableConstraint(java.lang.String constraintName, PsiElement variableNode, boolean completePattern, boolean target) Override this method to influence which UI controls are shown when editing the constraints of the specified variable.
boolean	isDocCommentOwner(PsiElement match)
boolean	isIdentifier(PsiElement element)
boolean	isMyLanguage(Language language)
void	provideAdditionalReplaceOptions(PsiElement node, ReplaceOptions options, ReplacementBuilder builder)
boolean	shouldShowProblem(PsiErrorElement error)
PsiElement	updateCurrentNode(PsiElement targetNode)

Methods inherited from class com.intellij.structuralsearch.StructuralSearchProfile

canBeVarDelimiter, createPatternTree, detectFileType, getContext, getPlaceholderVarName, isApplicableConstraint, isApplicableContextConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTEXT

public static final PatternContext DEFAULT_CONTEXT

MEMBER_CONTEXT

public static final PatternContext MEMBER_CONTEXT

Constructor Detail

JavaStructuralSearchProfile

public JavaStructuralSearchProfile()

Method Detail

getText

public java.lang.String getText(PsiElement match,
                                int start,
                                int end)

Overrides:

getText in class StructuralSearchProfile

getTypedVarString

public java.lang.String getTypedVarString(PsiElement element)

Overrides:

getTypedVarString in class StructuralSearchProfile

getMeaningfulText

public java.lang.String getMeaningfulText(PsiElement element)

Overrides:

getMeaningfulText in class StructuralSearchProfile

getAlternativeText

public java.lang.String getAlternativeText(PsiElement node,
                                           java.lang.String previousText)

Overrides:

getAlternativeText in class StructuralSearchProfile

updateCurrentNode

public PsiElement updateCurrentNode(PsiElement targetNode)

Overrides:

updateCurrentNode in class StructuralSearchProfile

extendMatchedByDownUp

public PsiElement extendMatchedByDownUp(PsiElement targetNode)

Overrides:

extendMatchedByDownUp in class StructuralSearchProfile

extendMatchOnePsiFile

public PsiElement extendMatchOnePsiFile(PsiElement file)

Overrides:

extendMatchOnePsiFile in class StructuralSearchProfile

getPresentableElement

public PsiElement getPresentableElement(PsiElement element)

Overrides:

getPresentableElement in class StructuralSearchProfile

compile

public void compile(PsiElement[] elements,
                    GlobalCompilingVisitor globalVisitor)

Specified by:

compile in class StructuralSearchProfile

createMatchingVisitor

public PsiElementVisitor createMatchingVisitor(GlobalMatchingVisitor globalVisitor)

Specified by:

createMatchingVisitor in class StructuralSearchProfile

getLexicalNodesFilter

public NodeFilter getLexicalNodesFilter()

Specified by:

getLexicalNodesFilter in class StructuralSearchProfile

createCompiledPattern

public CompiledPattern createCompiledPattern()

Specified by:

createCompiledPattern in class StructuralSearchProfile

getCustomPredicates

public java.util.List<MatchPredicate> getCustomPredicates(MatchVariableConstraint constraint,
                                                          java.lang.String name,
                                                          MatchOptions options)

Overrides:

getCustomPredicates in class StructuralSearchProfile

isMyLanguage

public boolean isMyLanguage(Language language)

Specified by:

isMyLanguage in class StructuralSearchProfile

getReplaceHandler

public StructuralReplaceHandler getReplaceHandler(Project project,
                                                  ReplaceOptions replaceOptions)

Overrides:

getReplaceHandler in class StructuralSearchProfile

createPatternTree

public PsiElement [] createPatternTree(java.lang.String text,
                                       PatternTreeContext context,
                                       LanguageFileType fileType,
                                       Language language,
                                       java.lang.String contextId,
                                       Project project,
                                       boolean physical)

Overrides:

createPatternTree in class StructuralSearchProfile

getTemplateContextTypeClass

public java.lang.Class<? extends TemplateContextType> getTemplateContextTypeClass()

Specified by:

getTemplateContextTypeClass in class StructuralSearchProfile

getPatternContexts

public java.util.List<PatternContext> getPatternContexts()

Overrides:

getPatternContexts in class StructuralSearchProfile

createCodeFragment

public PsiCodeFragment createCodeFragment(Project project,
                                          java.lang.String text,
                                          java.lang.String contextId)

Overrides:

createCodeFragment in class StructuralSearchProfile

getCodeFragmentText

public java.lang.String getCodeFragmentText(PsiFile fragment)

Description copied from class: StructuralSearchProfile

This method is called while holding a read action.

Overrides:

getCodeFragmentText in class StructuralSearchProfile

shouldShowProblem

public boolean shouldShowProblem(PsiErrorElement error)

Overrides:

shouldShowProblem in class StructuralSearchProfile

checkSearchPattern

public void checkSearchPattern(CompiledPattern pattern)

Overrides:

checkSearchPattern in class StructuralSearchProfile

checkReplacementPattern

public void checkReplacementPattern(Project project,
                                    ReplaceOptions options)

Overrides:

checkReplacementPattern in class StructuralSearchProfile

getDefaultFileType

public LanguageFileType getDefaultFileType(LanguageFileType currentDefaultFileType)

Overrides:

getDefaultFileType in class StructuralSearchProfile

getPredefinedTemplates

public Configuration[] getPredefinedTemplates()

Overrides:

getPredefinedTemplates in class StructuralSearchProfile

provideAdditionalReplaceOptions

public void provideAdditionalReplaceOptions(PsiElement node,
                                            ReplaceOptions options,
                                            ReplacementBuilder builder)

Overrides:

provideAdditionalReplaceOptions in class StructuralSearchProfile

handleSubstitution

public void handleSubstitution(ParameterInfo info,
                               MatchResult match,
                               java.lang.StringBuilder result,
                               ReplacementInfo replacementInfo)

Overrides:

handleSubstitution in class StructuralSearchProfile

handleNoSubstitution

public void handleNoSubstitution(ParameterInfo info,
                                 java.lang.StringBuilder result)

Overrides:

handleNoSubstitution in class StructuralSearchProfile

isIdentifier

public boolean isIdentifier(PsiElement element)

Overrides:

isIdentifier in class StructuralSearchProfile

getReservedWords

public java.util.Collection<java.lang.String> getReservedWords()

Overrides:

getReservedWords in class StructuralSearchProfile

isDocCommentOwner

public boolean isDocCommentOwner(PsiElement match)

Overrides:

isDocCommentOwner in class StructuralSearchProfile

isApplicableConstraint

public boolean isApplicableConstraint(java.lang.String constraintName,
                                      PsiElement variableNode,
                                      boolean completePattern,
                                      boolean target)

Description copied from class: StructuralSearchProfile

Override this method to influence which UI controls are shown when editing the constraints of the specified variable.

Overrides:

isApplicableConstraint in class StructuralSearchProfile

Parameters:

constraintName - the name of the constraint controls for which applicability is considered. See UIUtil for predefined constraint names

variableNode - the psi element corresponding to the current variable

completePattern - true, if the current variableNode encompasses the complete pattern. The variableNode can also be null in this case.

target - true, if the current variableNode is the target of the search

Returns:

true, if the requested constraint is applicable and the corresponding UI should be shown when editing the variable; false otherwise