replaced <code></code> with more concise {@code}
[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.NotNull;
22
23 /**
24  * Interface for processing roots of OrderEntry's from {@link OrderEnumerator}.
25  *
26  * @see OrderEnumerator#classes()
27  * @see OrderEnumerator#sources()
28  *
29  * @author nik
30  */
31 public interface OrderRootsEnumerator {
32   /**
33    * @return all roots processed by this enumerator
34    */
35   @NotNull
36   VirtualFile[] getRoots();
37
38   /**
39    * @return urls of all roots processed by this enumerator
40    */
41   @NotNull
42   String[] getUrls();
43
44   /**
45    * @return list of path to all roots processed by this enumerator
46    */
47   @NotNull
48   PathsList getPathsList();
49
50   /**
51    * Add all source roots processed by this enumerator to {@code list}
52    * @param list list
53    */
54   void collectPaths(@NotNull PathsList list);
55
56   /**
57    * If roots for this enumerator are already evaluated the cached result will be used. Otherwise roots will be evaluated and cached for
58    * subsequent calls. <p>
59    * Caching is not supported if {@link OrderEnumerator#satisfying}, {@link OrderEnumerator#using} or {@link #usingCustomRootProvider}
60    * option is used
61    * @return this instance
62    */
63   @NotNull
64   OrderRootsEnumerator usingCache();
65
66   /**
67    * 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
68    * {@link ModuleRootModel#orderEntries()}). It instructs the enumerator to skip the output of the main module (if {@link com.intellij.openapi.roots.OrderEnumerator#productionOnly()}
69    * option is not specified then only the test output will be skipped)
70    *
71    * @return this instance
72    */
73   @NotNull
74   OrderRootsEnumerator withoutSelfModuleOutput();
75
76   /**
77    * Use {@code provider} to obtain roots of an library or jdk order entry instead of {@link OrderEntry#getFiles(OrderRootType)} method. Note that
78    * this option won't affect result of {@link #getUrls()} method
79    * @param provider function to evaluate roots for an order entry
80    * @return this instance
81    */
82   @NotNull
83   OrderRootsEnumerator usingCustomRootProvider(@NotNull NotNullFunction<OrderEntry, VirtualFile[]> provider);
84 }