MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

moving javadocs to interface

Browse Source
This commit is contained in:
Eugene Zhuravlev
2013-02-27 14:59:27 +01:00
parent 1b895f5ac6
commit a6f7a0f1ac
2 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/indexing-api/src/com/intellij/util/indexing/FileBasedIndex.java
+15
View File
@@ -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 <K, V> boolean processValues(@NotNull ID<K, V> indexId,
@NotNull K dataKey,
@Nullable VirtualFile inFile,
@@ -86,9 +89,17 @@ public abstract class FileBasedIndex implements BaseComponent {
@Nullable Condition<V> valueChecker,
@NotNull Processor<VirtualFile> 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 <K> Collection<K> getAllKeys(@NotNull ID<K, ?> 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 <K> void ensureUpToDate(@NotNull ID<K, ?> 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<VirtualFile> 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 <K> boolean processAllKeys(@NotNull ID<K, ?> indexId, Processor<K> processor, @Nullable Project project);
public interface ValueProcessor<V> {
platform/lang-impl/src/com/intellij/util/indexing/FileBasedIndexImpl.java
-11
View File
@@ -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 <K> Collection<K> getAllKeys(@NotNull final ID<K, ?> 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 <K> boolean processAllKeys(@NotNull final ID<K, ?> indexId, Processor<K> 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 <K, V> boolean processValues(@NotNull final ID<K, V> indexId, @NotNull final K dataKey, @Nullable final VirtualFile inFile,
@NotNull ValueProcessor<V> processor, @NotNull final GlobalSearchScope filter) {