83d166a3eab5a4f9054fb6e43ad5d6357b2faf85
[idea/community.git] / java / java-psi-api / src / com / intellij / openapi / roots / PackageIndex.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.openapi.roots;
17
18 import com.intellij.openapi.components.ServiceManager;
19 import com.intellij.openapi.project.Project;
20 import com.intellij.openapi.vfs.VirtualFile;
21 import com.intellij.util.Query;
22 import org.jetbrains.annotations.NotNull;
23
24 /**
25  * Provides a possibility to query the directories corresponding to a specific Java package name.
26  */
27 public abstract class PackageIndex {
28   public static PackageIndex getInstance(Project project) {
29     return ServiceManager.getService(project, PackageIndex.class);
30   }
31
32   /**
33    * Returns all directories in content sources and libraries (and optionally library sources)
34    * corresponding to the given package name.
35    *
36    * @param packageName           the name of the package for which directories are requested.
37    * @param includeLibrarySources if true, directories under library sources are included in the returned list.
38    * @return the list of directories.
39    */
40   @NotNull
41   public abstract VirtualFile[] getDirectoriesByPackageName(@NotNull String packageName, boolean includeLibrarySources);
42
43   /**
44    * Returns all directories in content sources and libraries (and optionally library sources)
45    * corresponding to the given package name as a query object (allowing to perform partial iteration of the results).
46    *
47    * @param packageName           the name of the package for which directories are requested.
48    * @param includeLibrarySources if true, directories under library sources are included in the returned list.
49    * @return the query returning the list of directories.
50    */
51   @NotNull
52   public abstract Query<VirtualFile> getDirsByPackageName(@NotNull String packageName, boolean includeLibrarySources);
53 }