Package com.intellij.lang.java

Class JavaFindUsagesProvider

java.lang.Object

com.intellij.lang.java.JavaFindUsagesProvider

All Implemented Interfaces:

FindUsagesProvider

public class JavaFindUsagesProvider
extends java.lang.Object
implements FindUsagesProvider

Constructor Summary

Constructors

Constructor and Description
JavaFindUsagesProvider()

Method Summary

Modifier and Type	Method and Description
boolean	canFindUsagesFor(PsiElement element) Checks if it makes sense to search for usages of the specified element.
static java.lang.String	getDefaultPackageName()
java.lang.String	getDescriptiveName(PsiElement element) Returns an expanded user-visible name of the specified element, shown in the "Find Usages" dialog.
java.lang.String	getHelpId(PsiElement element) Returns the ID of the help topic which is shown when the specified element is selected in the "Find Usages" dialog.
java.lang.String	getNodeText(PsiElement element, boolean useFullName) Returns the text representing the specified PSI element in the Find Usages tree.
static java.lang.String	getPackageName(PsiDirectory directory, boolean includeRootDir)
static java.lang.String	getPackageName(PsiPackage psiPackage)
static java.lang.String	getRootDirectoryForPackage(PsiDirectory directory)
java.lang.String	getType(PsiElement element) Returns the user-visible type of the specified element, shown in the "Find Usages" dialog (for example, "class" or "variable").

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.lang.findUsages.FindUsagesProvider

getWordsScanner

Constructor Detail

JavaFindUsagesProvider

public JavaFindUsagesProvider()

Method Detail

canFindUsagesFor

public boolean canFindUsagesFor(PsiElement element)

Description copied from interface: FindUsagesProvider

Checks if it makes sense to search for usages of the specified element.

Specified by:

canFindUsagesFor in interface FindUsagesProvider

Parameters:

element - the element for which usages are searched.

Returns:

true if the search is allowed, false otherwise.

See Also:

FindManager.canFindUsages(PsiElement)

getHelpId

public java.lang.String getHelpId(PsiElement element)

Description copied from interface: FindUsagesProvider

Returns the ID of the help topic which is shown when the specified element is selected in the "Find Usages" dialog.

Specified by:

getHelpId in interface FindUsagesProvider

Parameters:

element - the element for which the help topic is requested.

Returns:

the help topic ID, or null if no help is available.

getType

public java.lang.String getType(PsiElement element)

Description copied from interface: FindUsagesProvider

Returns the user-visible type of the specified element, shown in the "Find Usages" dialog (for example, "class" or "variable"). The type name should not be upper-cased.

Specified by:

getType in interface FindUsagesProvider

Parameters:

element - the element for which the type is requested.

Returns:

the type of the element.

getDescriptiveName

public java.lang.String getDescriptiveName(PsiElement element)

Description copied from interface: FindUsagesProvider

Returns an expanded user-visible name of the specified element, shown in the "Find Usages" dialog. For classes, this can return a fully qualified name of the class; for methods - a signature of the method with parameters.

Specified by:

getDescriptiveName in interface FindUsagesProvider

Parameters:

element - the element for which the name is requested.

Returns:

the user-visible name.

getNodeText

public java.lang.String getNodeText(PsiElement element,
                                    boolean useFullName)

Description copied from interface: FindUsagesProvider

Returns the text representing the specified PSI element in the Find Usages tree.

Specified by:

getNodeText in interface FindUsagesProvider

Parameters:

element - the element for which the node text is requested.

useFullName - if true, the returned text should use fully qualified names

Returns:

the text representing the element.

getPackageName

public static java.lang.String getPackageName(PsiDirectory directory,
                                              boolean includeRootDir)

getRootDirectoryForPackage

public static java.lang.String getRootDirectoryForPackage(PsiDirectory directory)

getPackageName

public static java.lang.String getPackageName(PsiPackage psiPackage)

getDefaultPackageName

public static java.lang.String getDefaultPackageName()