diff --git a/platform/indexing-api/src/com/intellij/util/indexing/FileBasedIndex.java b/platform/indexing-api/src/com/intellij/util/indexing/FileBasedIndex.java index 29647eccbbfd..6851c99c954e 100644 --- a/platform/indexing-api/src/com/intellij/util/indexing/FileBasedIndex.java +++ b/platform/indexing-api/src/com/intellij/util/indexing/FileBasedIndex.java @@ -74,6 +74,9 @@ public abstract class FileBasedIndex implements BaseComponent { @NotNull K dataKey, @NotNull GlobalSearchScope filter); + /** + * @return false if ValueProcessor.process() returned false; true otherwise or if ValueProcessor was not called at all + */ public abstract boolean processValues(@NotNull ID indexId, @NotNull K dataKey, @Nullable VirtualFile inFile, @@ -86,9 +89,17 @@ public abstract class FileBasedIndex implements BaseComponent { @Nullable Condition valueChecker, @NotNull Processor processor); + /** + * @param project it is guaranteed to return data which is up-to-date withing the project + * Keys obtained from the files which do not belong to the project specified may not be up-to-date or even exist + */ @NotNull public abstract Collection getAllKeys(@NotNull ID indexId, @NotNull Project project); + /** + * DO NOT CALL DIRECTLY IN CLIENT CODE + * The method is internal to indexing engine end is called internally. The method is public due to implementation details + */ public abstract void ensureUpToDate(@NotNull ID indexId, @Nullable Project project, @Nullable GlobalSearchScope filter); public abstract void requestRebuild(ID indexId, Throwable throwable); @@ -104,6 +115,10 @@ public abstract class FileBasedIndex implements BaseComponent { @NotNull Processor processor, @NotNull GlobalSearchScope filter); + /** + * @param project it is guaranteed to return data which is up-to-date withing the project + * Keys obtained from the files which do not belong to the project specified may not be up-to-date or even exist + */ public abstract boolean processAllKeys(@NotNull ID indexId, Processor processor, @Nullable Project project); public interface ValueProcessor { diff --git a/platform/lang-impl/src/com/intellij/util/indexing/FileBasedIndexImpl.java b/platform/lang-impl/src/com/intellij/util/indexing/FileBasedIndexImpl.java index 98e646369d21..b2ded8afaaea 100644 --- a/platform/lang-impl/src/com/intellij/util/indexing/FileBasedIndexImpl.java +++ b/platform/lang-impl/src/com/intellij/util/indexing/FileBasedIndexImpl.java @@ -675,10 +675,6 @@ public class FileBasedIndexImpl extends FileBasedIndex { } } - /** - * @param project it is guaranteed to return data which is up-to-date withing the project - * Keys obtained from the files which do not belong to the project specified may not be up-to-date or even exist - */ @Override @NotNull public Collection getAllKeys(@NotNull final ID indexId, @NotNull Project project) { @@ -687,10 +683,6 @@ public class FileBasedIndexImpl extends FileBasedIndex { return allKeys; } - /** - * @param project it is guaranteed to return data which is up-to-date withing the project - * Keys obtained from the files which do not belong to the project specified may not be up-to-date or even exist - */ @Override public boolean processAllKeys(@NotNull final ID indexId, Processor processor, @Nullable Project project) { try { @@ -867,9 +859,6 @@ public class FileBasedIndexImpl extends FileBasedIndex { } - /** - * @return false if ValueProcessor.process() returned false; true otherwise or if ValueProcessor was not called at all - */ @Override public boolean processValues(@NotNull final ID indexId, @NotNull final K dataKey, @Nullable final VirtualFile inFile, @NotNull ValueProcessor processor, @NotNull final GlobalSearchScope filter) {