add @NotNull
[idea/community.git] / platform / indexing-api / src / com / intellij / util / indexing / IndexableSetContributor.java
1 /*
2  * Copyright 2000-2015 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.util.indexing;
17
18 import com.intellij.openapi.project.Project;
19 import com.intellij.openapi.vfs.VirtualFile;
20 import com.intellij.openapi.vfs.VirtualFileManager;
21 import com.intellij.util.NotNullFunction;
22 import com.intellij.util.containers.ContainerUtil;
23 import org.jetbrains.annotations.NotNull;
24
25 import java.util.Collections;
26 import java.util.HashSet;
27 import java.util.Set;
28
29 /**
30  * @author peter
31  */
32 public abstract class IndexableSetContributor implements IndexedRootsProvider {
33   
34   protected static final Set<VirtualFile> EMPTY_FILE_SET = Collections.emptySet();
35
36   @Override
37   public final Set<String> getRootsToIndex() {
38     return ContainerUtil.map2Set(getAdditionalRootsToIndex(), new NotNullFunction<VirtualFile, String>() {
39       @NotNull
40       @Override
41       public String fun(VirtualFile virtualFile) {
42         return virtualFile.getUrl();
43       }
44     });
45   }
46
47   @NotNull
48   public static Set<VirtualFile> getProjectRootsToIndex(IndexedRootsProvider provider, Project project) {
49     if (provider instanceof IndexableSetContributor) {
50       return ((IndexableSetContributor)provider).getAdditionalProjectRootsToIndex(project);
51     }
52     return EMPTY_FILE_SET;
53   }
54
55   public static Set<VirtualFile> getRootsToIndex(IndexedRootsProvider provider) {
56     if (provider instanceof IndexableSetContributor) {
57       return ((IndexableSetContributor)provider).getAdditionalRootsToIndex();
58     }
59
60     final HashSet<VirtualFile> result = new HashSet<VirtualFile>();
61     for (String url : provider.getRootsToIndex()) {
62       ContainerUtil.addIfNotNull(VirtualFileManager.getInstance().findFileByUrl(url), result);
63     }
64
65     return result;
66   }
67
68   @NotNull
69   public Set<VirtualFile> getAdditionalProjectRootsToIndex(@NotNull Project project) {
70     return EMPTY_FILE_SET;
71   }
72
73   @NotNull
74   public abstract Set<VirtualFile> getAdditionalRootsToIndex();
75 }