some javadoc

This commit is contained in:
Dmitry Jemerov
2014-12-05 11:44:54 +01:00
parent 11b9f0883f
commit cebd77af7a
2 changed files with 20 additions and 1 deletions

View File

@@ -21,6 +21,9 @@ import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.util.Query;
import org.jetbrains.annotations.NotNull;
/**
* Provides a possibility to query the directories corresponding to a specific Java package name.
*/
public abstract class PackageIndex {
public static PackageIndex getInstance(Project project) {
return ServiceManager.getService(project, PackageIndex.class);
@@ -36,5 +39,13 @@ public abstract class PackageIndex {
*/
public abstract VirtualFile[] getDirectoriesByPackageName(@NotNull 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).
*
* @param packageName the name of the package for which directories are requested.
* @param includeLibrarySources if true, directories under library sources are included in the returned list.
* @return the query returning the list of directories.
*/
public abstract Query<VirtualFile> getDirsByPackageName(@NotNull String packageName, boolean includeLibrarySources);
}

View File

@@ -24,6 +24,9 @@ import com.intellij.util.messages.Topic;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* Manages the background highlighting and auto-import for files displayed in editors.
*/
public abstract class DaemonCodeAnalyzer {
public static DaemonCodeAnalyzer getInstance(Project project) {
return project.getComponent(DaemonCodeAnalyzer.class);
@@ -46,9 +49,14 @@ public abstract class DaemonCodeAnalyzer {
public abstract boolean isAutohintsAvailable(@Nullable PsiFile file);
/**
* Force rehighlighting for all files
* Force rehighlighting for all files.
*/
public abstract void restart();
/**
* Force rehighlighting for a specific file.
* @param file the file to rehighlight.
*/
public abstract void restart(@NotNull PsiFile file);
public abstract void autoImportReferenceAtCursor(@NotNull Editor editor, @NotNull PsiFile file);