Package com.intellij.openapi.roots

Class PackageIndex

java.lang.Object

com.intellij.openapi.roots.PackageIndex

Direct Known Subclasses:

CorePackageIndex, ModulePackageIndex

public abstract class PackageIndex
extends java.lang.Object

Provides a possibility to query the directories corresponding to a specific Java package name.

Constructor Summary

Constructors

Constructor and Description
PackageIndex()

Method Summary

Modifier and Type	Method and Description
abstract VirtualFile []	getDirectoriesByPackageName(java.lang.String packageName, boolean includeLibrarySources) Returns all directories in content sources and libraries (and optionally library sources) corresponding to the given package name.
abstract Query<VirtualFile>	getDirsByPackageName(java.lang.String packageName, boolean includeLibrarySources) Returns all directories in content sources and libraries (and optionally library sources) corresponding to the given package name as a query object (allowing to perform partial iteration of the results).
static PackageIndex	getInstance(Project project)

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageIndex

public PackageIndex()

Method Detail

getInstance

public static PackageIndex getInstance(Project project)

getDirectoriesByPackageName

public abstract VirtualFile [] getDirectoriesByPackageName(java.lang.String packageName,
                                                           boolean includeLibrarySources)

Returns all directories in content sources and libraries (and optionally library sources) corresponding to the given package name.

Parameters:

packageName - the name of the package for which directories are requested.

includeLibrarySources - if true, directories under library sources are included in the returned list.

Returns:

the list of directories.

getDirsByPackageName

public abstract Query<VirtualFile> getDirsByPackageName(java.lang.String packageName,
                                                        boolean includeLibrarySources)

Returns all directories in content sources and libraries (and optionally library sources) corresponding to the given package name as a query object (allowing to perform partial iteration of the results).

Parameters:

packageName - the name of the package for which directories are requested.

includeLibrarySources - if true, directories under library sources are included in the returned list.

Returns:

the query returning the list of directories.