[groovy] IDEA-251135: Set explicit return type for method with inferred platform...
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / OrderRootsEnumerator.java
1 /*
2  * Copyright 2000-2010 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.vfs.VirtualFile;
19 import com.intellij.util.NotNullFunction;
20 import com.intellij.util.PathsList;
21 import org.jetbrains.annotations.ApiStatus;
22 import org.jetbrains.annotations.NotNull;
23
24 /**
25  * Interface for processing roots of OrderEntry's from {@link OrderEnumerator}.
26  *
27  * @see OrderEnumerator#classes()
28  * @see OrderEnumerator#sources()
29  */
30 @ApiStatus.NonExtendable
31 public interface OrderRootsEnumerator {
32   /**
33    * @return all roots processed by this enumerator
34    */
35   VirtualFile @NotNull [] getRoots();
36
37   /**
38    * @return urls of all roots processed by this enumerator
39    */
40   String @NotNull [] getUrls();
41
42   /**
43    * @return list of path to all roots processed by this enumerator
44    */
45   @NotNull
46   PathsList getPathsList();
47
48   /**
49    * Add all source roots processed by this enumerator to {@code list}
50    * @param list list
51    */
52   void collectPaths(@NotNull PathsList list);
53
54   /**
55    * If roots for this enumerator are already evaluated the cached result will be used. Otherwise roots will be evaluated and cached for
56    * subsequent calls. <p>
57    * Caching is not supported if {@link OrderEnumerator#satisfying}, {@link OrderEnumerator#using} or {@link #usingCustomRootProvider}
58    * option is used
59    * @return this instance
60    */
61   @NotNull
62   OrderRootsEnumerator usingCache();
63
64   /**
65    * This method makes sense only when dependencies of a module are processed (i.e. the enumerator instance is obtained by using {@link OrderEnumerator#orderEntries(com.intellij.openapi.module.Module)} or
66    * {@link ModuleRootModel#orderEntries()}). It instructs the enumerator to skip the output of the main module (if {@link OrderEnumerator#productionOnly()}
67    * option is not specified then only the test output will be skipped)
68    *
69    * @return this instance
70    */
71   @NotNull
72   OrderRootsEnumerator withoutSelfModuleOutput();
73
74   /**
75    * Use {@code provider} to obtain roots of an library or jdk order entry instead of {@link OrderEntry#getFiles(OrderRootType)} method. Note that
76    * this option won't affect result of {@link #getUrls()} method
77    * @param provider function to evaluate roots for an order entry
78    * @return this instance
79    */
80   @NotNull
81   OrderRootsEnumerator usingCustomRootProvider(@NotNull NotNullFunction<? super OrderEntry, VirtualFile[]> provider);
82 }