Package org.aspectj.org.eclipse.jdt.internal.core.search.matching

Class PatternLocator

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.search.matching.PatternLocator

All Implemented Interfaces:

IQualifiedTypeResolutionListener, IIndexConstants

Direct Known Subclasses:

AndLocator, ConstructorLocator, MethodLocator, ModuleLocator, OrLocator, PackageDeclarationLocator, PackageReferenceLocator, SuperTypeReferenceLocator, TypeDeclarationLocator, TypeParameterLocator, TypeReferenceLocator, VariableLocator

public abstract class PatternLocator
extends Object
implements IIndexConstants, IQualifiedTypeResolutionListener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ACCURATE_MATCH
static final int	ALL_CONTAINER
static final int	CAMELCASE_FLAVOR
static final int	CLASS_CONTAINER
static final int	COMPILATION_UNIT_CONTAINER
static final int	ERASURE_MATCH
static final int	EXACT_FLAVOR
static final int	FIELD_CONTAINER
static final int	FLAVORS_MASK
static final int	IMPOSSIBLE_MATCH
static final int	INACCURATE_MATCH
protected boolean	isCaseSensitive
protected boolean	isEquivalentMatch
protected boolean	isErasureMatch
static final int	MATCH_LEVEL_MASK
protected int	matchMode
protected boolean	mayBeGeneric
static final int	METHOD_CONTAINER
protected boolean	mustResolve
static final int	NO_FLAVOR
static final int	OVERRIDDEN_METHOD_FLAVOR
static final int	PATTERN_FLAVOR
static final int	POSSIBLE_MATCH
static final int	PREFIX_FLAVOR
static final int	RAW_MASK
static final int	REGEXP_FLAVOR
static final int	RULE_MASK
static final int	SUB_INVOCATION_FLAVOR
static final int	SUPER_INVOCATION_FLAVOR
static final int	SUPERTYPE_REF_FLAVOR

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.core.search.indexing.IIndexConstants

AND_PATTERN, ANNOT_REF_PATTERN, ANNOTATION_REF, ANNOTATION_TYPE_SUFFIX, CLASS_AND_ENUM_SUFFIX, CLASS_AND_INTERFACE_SUFFIX, CLASS_SUFFIX, CONSTRUCTOR_DECL, CONSTRUCTOR_PATTERN, CONSTRUCTOR_REF, COUNTS, DEFAULT_CONSTRUCTOR, ENUM_SUFFIX, FIELD_DECL, FIELD_PATTERN, INTERFACE_AND_ANNOTATION_SUFFIX, INTERFACE_SUFFIX, LOCAL_VAR_PATTERN, META_INDEX_CATEGORIES, META_INDEX_QUALIFIED_SUPER_TYPE_QUALIFIER_REF, META_INDEX_QUALIFIED_TYPE_QUALIFIER_REF, META_INDEX_SIMPLE_SUPER_TYPE_QUALIFIER_REF, META_INDEX_SIMPLE_TYPE_QUALIFIER_REF, METHOD_DECL, METHOD_DECL_PLUS, METHOD_PATTERN, METHOD_REF, MODULE_DECL, MODULE_INFO, MODULE_PATTERN, MODULE_REF, OBJECT, ONE_STAR, ONE_STAR_CHAR, ONE_ZERO, ONE_ZERO_CHAR, OR_PATTERN, PARAMETER_SEPARATOR, PKG_DECL_PATTERN, PKG_REF_PATTERN, REF, SECONDARY_SUFFIX, SEPARATOR, SUPER_REF, SUPER_REF_PATTERN, TYPE_DECL, TYPE_DECL_PATTERN, TYPE_PARAM_PATTERN, TYPE_REF_PATTERN, TYPE_SUFFIX, ZERO_CHAR

Constructor Summary

Constructors

Constructor	Description
PatternLocator(SearchPattern pattern)

Method Summary

Modifier and Type	Method	Description
protected void	clear()
protected int	fineGrain()
protected char[]	getQualifiedPattern(char[] simpleNamePattern, char[] qualificationPattern)
protected char[]	getQualifiedSourceName(TypeBinding binding)
protected TypeBinding	getTypeNameBinding(int index)
void	initializePolymorphicSearch(MatchLocator locator)	Initializes this search pattern so that polymorphic search can be performed.
int	match(Annotation node, MatchingNodeSet nodeSet)
int	match(ASTNode node, MatchingNodeSet nodeSet)	Check if the given ast node syntactically matches this pattern.
int	match(ConstructorDeclaration node, MatchingNodeSet nodeSet)
int	match(Expression node, MatchingNodeSet nodeSet)
int	match(FieldDeclaration node, MatchingNodeSet nodeSet)
int	match(LambdaExpression node, MatchingNodeSet nodeSet)
int	match(LocalDeclaration node, MatchingNodeSet nodeSet)
int	match(MemberValuePair node, MatchingNodeSet nodeSet)
int	match(MessageSend node, MatchingNodeSet nodeSet)
int	match(MethodDeclaration node, MatchingNodeSet nodeSet)
protected int	match(ModuleDeclaration node, MatchingNodeSet nodeSet)
protected int	match(ModuleReference node, MatchingNodeSet nodeSet)
int	match(ReferenceExpression node, MatchingNodeSet nodeSet)
int	match(Reference node, MatchingNodeSet nodeSet)
int	match(TypeDeclaration node, MatchingNodeSet nodeSet)
int	match(TypeParameter node, MatchingNodeSet nodeSet)
int	match(TypeReference node, MatchingNodeSet nodeSet)
protected int	matchContainer()	Returns the type(s) of container for this pattern.
protected boolean	matchesName(char[] pattern, char[] name)	Returns whether the given name matches the given pattern.
protected boolean	matchesTypeReference(char[] pattern, TypeReference type)	Returns whether the given type reference matches the given pattern.
protected int	matchLevel(ImportReference importRef)	Returns the match level for the given importRef.
protected void	matchLevelAndReportImportRef(ImportReference importRef, Binding binding, MatchLocator locator)	Reports the match of the given import reference if the resolveLevel is high enough.
protected int	matchNameValue(char[] pattern, char[] name)	Return how the given name matches the given pattern.
protected void	matchReportImportRef(ImportReference importRef, Binding binding, IJavaElement element, int accuracy, MatchLocator locator)	Reports the match of the given import reference.
protected void	matchReportReference(ASTNode reference, IJavaElement element, IJavaElement localElement, IJavaElement[] otherElements, Binding elementBinding, int accuracy, MatchLocator locator)	Reports the match of the given reference.
protected void	matchReportReference(ASTNode reference, IJavaElement element, Binding elementBinding, int accuracy, MatchLocator locator)	Reports the match of the given reference.
SearchMatch	newDeclarationMatch(ASTNode reference, IJavaElement element, Binding elementBinding, int accuracy, int length, MatchLocator locator)
static PatternLocator	patternLocator(SearchPattern pattern)
static char[]	qualifiedPattern(char[] simpleNamePattern, char[] qualificationPattern)
static char[]	qualifiedSourceName(TypeBinding binding)
void	recordResolution(QualifiedTypeReference typeReference, TypeBinding resolution)	Notifies that the given resolution has been found for the given type reference.
protected int	referenceType()
int	resolveLevel(ASTNode possibleMatchingNode)	Finds out whether the given ast node matches this search pattern.
int	resolveLevel(Binding binding)	Finds out whether the given binding matches this search pattern.
protected int	resolveLevelForType(char[] simpleNamePattern, char[] qualificationPattern, char[][][] patternTypeArguments, int depth, TypeBinding type)
protected int	resolveLevelForType(char[] simpleNamePattern, char[] qualificationPattern, TypeBinding binding)	Returns whether the given type binding matches the given simple name pattern and qualification pattern.
protected int	resolveLevelForType(char[] qualifiedPattern, TypeBinding type)	Returns whether the given type binding matches the given qualified pattern.
String	toString()
protected void	updateMatch(ParameterizedTypeBinding parameterizedBinding, char[][][] patternTypeArguments, boolean patternHasTypeParameters, int depth, MatchLocator locator)
protected void	updateMatch(ParameterizedTypeBinding parameterizedBinding, char[][][] patternTypeArguments, MatchLocator locator)
protected void	updateMatch(TypeBinding[] argumentsBinding, MatchLocator locator, char[][] patternArguments, boolean hasTypeParameters)

Methods inherited from class java.lang.Object

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

Field Details

matchMode

protected int matchMode

isCaseSensitive

protected boolean isCaseSensitive

isEquivalentMatch

protected boolean isEquivalentMatch

isErasureMatch

protected boolean isErasureMatch

mustResolve

protected boolean mustResolve

mayBeGeneric

protected boolean mayBeGeneric

IMPOSSIBLE_MATCH

public static final int IMPOSSIBLE_MATCH

See Also:

• Constant Field Values

INACCURATE_MATCH

public static final int INACCURATE_MATCH

See Also:

• Constant Field Values

POSSIBLE_MATCH

public static final int POSSIBLE_MATCH

See Also:

• Constant Field Values

ACCURATE_MATCH

public static final int ACCURATE_MATCH

See Also:

• Constant Field Values

ERASURE_MATCH

public static final int ERASURE_MATCH

See Also:

• Constant Field Values

NO_FLAVOR

public static final int NO_FLAVOR

See Also:

• Constant Field Values

EXACT_FLAVOR

public static final int EXACT_FLAVOR

See Also:

• Constant Field Values

PREFIX_FLAVOR

public static final int PREFIX_FLAVOR

See Also:

• Constant Field Values

PATTERN_FLAVOR

public static final int PATTERN_FLAVOR

See Also:

• Constant Field Values

REGEXP_FLAVOR

public static final int REGEXP_FLAVOR

See Also:

• Constant Field Values

CAMELCASE_FLAVOR

public static final int CAMELCASE_FLAVOR

See Also:

• Constant Field Values

SUPER_INVOCATION_FLAVOR

public static final int SUPER_INVOCATION_FLAVOR

See Also:

• Constant Field Values

SUB_INVOCATION_FLAVOR

public static final int SUB_INVOCATION_FLAVOR

See Also:

• Constant Field Values

OVERRIDDEN_METHOD_FLAVOR

public static final int OVERRIDDEN_METHOD_FLAVOR

See Also:

• Constant Field Values

SUPERTYPE_REF_FLAVOR

public static final int SUPERTYPE_REF_FLAVOR

See Also:

• Constant Field Values

MATCH_LEVEL_MASK

public static final int MATCH_LEVEL_MASK

See Also:

• Constant Field Values

FLAVORS_MASK

public static final int FLAVORS_MASK

See Also:

• Constant Field Values

COMPILATION_UNIT_CONTAINER

public static final int COMPILATION_UNIT_CONTAINER

See Also:

• Constant Field Values

CLASS_CONTAINER

public static final int CLASS_CONTAINER

See Also:

• Constant Field Values

METHOD_CONTAINER

public static final int METHOD_CONTAINER

See Also:

• Constant Field Values

FIELD_CONTAINER

public static final int FIELD_CONTAINER

See Also:

• Constant Field Values

ALL_CONTAINER

public static final int ALL_CONTAINER

See Also:

• Constant Field Values

RAW_MASK

public static final int RAW_MASK

See Also:

• Constant Field Values

RULE_MASK

public static final int RULE_MASK

See Also:

• Constant Field Values

Constructor Details

PatternLocator

public PatternLocator(SearchPattern pattern)

Method Details

patternLocator

public static PatternLocator patternLocator(SearchPattern pattern)

qualifiedPattern

public static char[] qualifiedPattern(char[] simpleNamePattern,
 char[] qualificationPattern)

qualifiedSourceName

public static char[] qualifiedSourceName(TypeBinding binding)

clear

protected void clear()

getQualifiedPattern

protected char[] getQualifiedPattern(char[] simpleNamePattern,
 char[] qualificationPattern)

getQualifiedSourceName

protected char[] getQualifiedSourceName(TypeBinding binding)

getTypeNameBinding

protected TypeBinding getTypeNameBinding(int index)

initializePolymorphicSearch

public void initializePolymorphicSearch(MatchLocator locator)

Initializes this search pattern so that polymorphic search can be performed.

match

public int match(Annotation node,
 MatchingNodeSet nodeSet)

match

public int match(ASTNode node,
 MatchingNodeSet nodeSet)

Check if the given ast node syntactically matches this pattern. If it does, add it to the match set. Returns the match level.

match

public int match(ConstructorDeclaration node,
 MatchingNodeSet nodeSet)

match

public int match(Expression node,
 MatchingNodeSet nodeSet)

match

public int match(FieldDeclaration node,
 MatchingNodeSet nodeSet)

match

public int match(LambdaExpression node,
 MatchingNodeSet nodeSet)

match

public int match(LocalDeclaration node,
 MatchingNodeSet nodeSet)

match

public int match(MethodDeclaration node,
 MatchingNodeSet nodeSet)

match

public int match(MemberValuePair node,
 MatchingNodeSet nodeSet)

match

public int match(MessageSend node,
 MatchingNodeSet nodeSet)

match

protected int match(ModuleDeclaration node,
 MatchingNodeSet nodeSet)

match

protected int match(ModuleReference node,
 MatchingNodeSet nodeSet)

match

public int match(Reference node,
 MatchingNodeSet nodeSet)

match

public int match(ReferenceExpression node,
 MatchingNodeSet nodeSet)

match

public int match(TypeDeclaration node,
 MatchingNodeSet nodeSet)

match

public int match(TypeParameter node,
 MatchingNodeSet nodeSet)

match

public int match(TypeReference node,
 MatchingNodeSet nodeSet)

matchContainer

protected int matchContainer()

Returns the type(s) of container for this pattern. It is a bit combination of types, denoting compilation unit, class declarations, field declarations or method declarations.

fineGrain

protected int fineGrain()

matchesName

protected boolean matchesName(char[] pattern,
 char[] name)

Returns whether the given name matches the given pattern.

matchNameValue

protected int matchNameValue(char[] pattern,
 char[] name)

Return how the given name matches the given pattern.

Returns:

Possible values are:

• ACCURATE_MATCH
• IMPOSSIBLE_MATCH
• POSSIBLE_MATCH which may be flavored with following values:
  • EXACT_FLAVOR: Given name is equals to pattern
  • PREFIX_FLAVOR: Given name prefix equals to pattern
  • CAMELCASE_FLAVOR: Given name matches pattern as Camel Case
  • PATTERN_FLAVOR: Given name matches pattern as Pattern (i.e. using '*' and '?' characters)

See Also:

• "https://bugs.eclipse.org/bugs/show_bug.cgi?id=79866"

matchesTypeReference

protected boolean matchesTypeReference(char[] pattern,
 TypeReference type)

Returns whether the given type reference matches the given pattern.

matchLevel

protected int matchLevel(ImportReference importRef)

Returns the match level for the given importRef.

matchLevelAndReportImportRef

protected void matchLevelAndReportImportRef(ImportReference importRef,
 Binding binding,
 MatchLocator locator)
                                     throws org.eclipse.core.runtime.CoreException

Reports the match of the given import reference if the resolveLevel is high enough.

Throws:

org.eclipse.core.runtime.CoreException

matchReportImportRef

protected void matchReportImportRef(ImportReference importRef,
 Binding binding,
 IJavaElement element,
 int accuracy,
 MatchLocator locator)
                             throws org.eclipse.core.runtime.CoreException

Reports the match of the given import reference.

Throws:

org.eclipse.core.runtime.CoreException

matchReportReference

protected void matchReportReference(ASTNode reference,
 IJavaElement element,
 Binding elementBinding,
 int accuracy,
 MatchLocator locator)
                             throws org.eclipse.core.runtime.CoreException

Reports the match of the given reference.

Throws:

org.eclipse.core.runtime.CoreException

matchReportReference

protected void matchReportReference(ASTNode reference,
 IJavaElement element,
 IJavaElement localElement,
 IJavaElement[] otherElements,
 Binding elementBinding,
 int accuracy,
 MatchLocator locator)
                             throws org.eclipse.core.runtime.CoreException

Reports the match of the given reference. Also provide a local element to eventually report in match.

Throws:

org.eclipse.core.runtime.CoreException

newDeclarationMatch

public SearchMatch newDeclarationMatch(ASTNode reference,
 IJavaElement element,
 Binding elementBinding,
 int accuracy,
 int length,
 MatchLocator locator)

referenceType

protected int referenceType()

resolveLevel

public int resolveLevel(ASTNode possibleMatchingNode)

Finds out whether the given ast node matches this search pattern. Returns IMPOSSIBLE_MATCH if it doesn't. Returns INACCURATE_MATCH if it potentially matches this search pattern (i.e. it has already been resolved but resolving failed.) Returns ACCURATE_MATCH if it matches exactly this search pattern (i.e. it doesn't need to be resolved or it has already been resolved.)

updateMatch

protected void updateMatch(ParameterizedTypeBinding parameterizedBinding,
 char[][][] patternTypeArguments,
 MatchLocator locator)

updateMatch

protected void updateMatch(ParameterizedTypeBinding parameterizedBinding,
 char[][][] patternTypeArguments,
 boolean patternHasTypeParameters,
 int depth,
 MatchLocator locator)

updateMatch

protected void updateMatch(TypeBinding[] argumentsBinding,
 MatchLocator locator,
 char[][] patternArguments,
 boolean hasTypeParameters)

resolveLevel

public int resolveLevel(Binding binding)

Finds out whether the given binding matches this search pattern. Returns ACCURATE_MATCH if it does. Returns INACCURATE_MATCH if resolve failed but match is still possible. Returns IMPOSSIBLE_MATCH otherwise. Default is to return INACCURATE_MATCH.

resolveLevelForType

protected int resolveLevelForType(char[] simpleNamePattern,
 char[] qualificationPattern,
 TypeBinding binding)

Returns whether the given type binding matches the given simple name pattern and qualification pattern. Note that from since 3.1, this method resolve to accurate member or local types even if they are not fully qualified (i.e. X.Member instead of p.X.Member). Returns ACCURATE_MATCH if it does. Returns INACCURATE_MATCH if resolve failed. Returns IMPOSSIBLE_MATCH if it doesn't.

resolveLevelForType

protected int resolveLevelForType(char[] qualifiedPattern,
 TypeBinding type)

Returns whether the given type binding matches the given qualified pattern. Returns ACCURATE_MATCH if it does. Returns INACCURATE_MATCH if resolve failed. Returns IMPOSSIBLE_MATCH if it doesn't.

resolveLevelForType

protected int resolveLevelForType(char[] simpleNamePattern,
 char[] qualificationPattern,
 char[][][] patternTypeArguments,
 int depth,
 TypeBinding type)

toString

public String toString()

Overrides:

toString in class Object

recordResolution

public void recordResolution(QualifiedTypeReference typeReference,
 TypeBinding resolution)

Description copied from interface: IQualifiedTypeResolutionListener

Notifies that the given resolution has been found for the given type reference. Some of the bindings are intermediate types i.e. qualifying types.

Specified by:

recordResolution in interface IQualifiedTypeResolutionListener

Parameters:

typeReference - the type reference

resolution - the resolution found