Package org.eclipse.jdt.core.search
Class TypeNameMatch
java.lang.Object
org.eclipse.jdt.core.search.TypeNameMatch
A match collected while
searching
for
all type names methods using a requestor
.
The type of this match is available from getType()
.
- Since:
- 3.3
- See Also:
-
TypeNameMatchRequestor
SearchEngine.searchAllTypeNames(char[], int, char[], int, int, IJavaSearchScope, TypeNameMatchRequestor, int, org.eclipse.core.runtime.IProgressMonitor)
SearchEngine.searchAllTypeNames(char[][], char[][], IJavaSearchScope, TypeNameMatchRequestor, int, org.eclipse.core.runtime.IProgressMonitor)
- Restriction:
- This class is not intended to be subclassed by clients.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract int
Returns the accessibility of the type name matchReturns the matched type's fully qualified name using '.' character as separator (e.g. package name + '.' enclosing type names + '.' simple name).abstract int
Returns the modifiers of the matched type.Returns the package fragment root of the stored type.Returns the package name of the stored type.Returns the name of the stored type.abstract IType
getType()
Returns a java model type handle.Name of the type container using '.' character as separator (e.g. package name + '.' + enclosing type names).Returns the matched type's type qualified name using '.' character as separator (e.g. enclosing type names + '.' + simple name).
-
Constructor Details
-
TypeNameMatch
public TypeNameMatch()
-
-
Method Details
-
getAccessibility
public abstract int getAccessibility()Returns the accessibility of the type name match- Returns:
- the accessibility of the type name which may be
IAccessRule.K_ACCESSIBLE
,IAccessRule.K_DISCOURAGED
orIAccessRule.K_NON_ACCESSIBLE
. The default returned value isIAccessRule.K_ACCESSIBLE
. - Since:
- 3.6
- See Also:
-
getFullyQualifiedName
Returns the matched type's fully qualified name using '.' character as separator (e.g. package name + '.' enclosing type names + '.' simple name).- Returns:
- Fully qualified type name of the type
- Throws:
NullPointerException
- if matched type isnull
- See Also:
-
getModifiers
public abstract int getModifiers()Returns the modifiers of the matched type.This is a handle-only method as neither Java Model nor classpath initialization is done while calling this method.
- Returns:
- the type modifiers
-
getPackageFragmentRoot
Returns the package fragment root of the stored type. Package fragment root cannot be null and does exist.- Returns:
- the existing java model package fragment root (i.e. cannot be
null
and will returntrue
toexists()
message). - Throws:
NullPointerException
- if matched type isnull
- See Also:
-
getPackageName
Returns the package name of the stored type.- Returns:
- the package name
- Throws:
NullPointerException
- if matched type isnull
- See Also:
-
getSimpleTypeName
Returns the name of the stored type.- Returns:
- the type name
- Throws:
NullPointerException
- if matched type isnull
- See Also:
-
getType
Returns a java model type handle. This handle may exist or not, but is not supposed to benull
.This is a handle-only method as neither Java Model nor classpath initializations are done while calling this method.
- Returns:
- the non-null handle on matched java model type.
- See Also:
-
getTypeContainerName
Name of the type container using '.' character as separator (e.g. package name + '.' + enclosing type names).- Returns:
- name of the type container
- Throws:
NullPointerException
- if matched type isnull
- See Also:
-
getTypeQualifiedName
Returns the matched type's type qualified name using '.' character as separator (e.g. enclosing type names + '.' + simple name).- Returns:
- fully qualified type name of the type
- Throws:
NullPointerException
- if matched type isnull
- See Also:
-