api: annotate classes and interfaces from project model API as NonExtendable
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / OrderEntry.java
1 /*
2  * Copyright 2000-2012 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.module.Module;
19 import com.intellij.openapi.vfs.VirtualFile;
20 import org.jetbrains.annotations.ApiStatus;
21 import org.jetbrains.annotations.NotNull;
22 import org.jetbrains.annotations.Nullable;
23
24 /**
25  * Represents an entry in the classpath of a module (as shown in the "Order/Export" page
26  * of the module configuration dialog).
27  *
28  * @author dsl
29  */
30 @ApiStatus.NonExtendable
31 public interface OrderEntry extends Synthetic, Comparable<OrderEntry> {
32   /**
33    * The empty array of order entries which can be reused to avoid unnecessary allocations.
34    */
35   OrderEntry[] EMPTY_ARRAY = new OrderEntry[0];
36
37   /**
38    * Returns list of root {@link VirtualFile}s of given type for this entry.
39    * Those files should be traversed in order they are returned in.
40    * Note that actual OrderEntry (as seen in UI) may also contain invalid roots.
41    * If you want to get list of all roots, use {@link #getUrls(OrderRootType)} method. <br>
42    *
43    * Note that list of roots is project dependent.
44    *
45    * @param type  required root type.
46    * @return list of virtual files.
47    * @see #getUrls(OrderRootType)
48    */
49   @NotNull
50   VirtualFile[] getFiles(@NotNull OrderRootType type);
51
52   /**
53    * Returns list of roots of given type for this entry. To validate returned roots,
54    * use {@link com.intellij.openapi.vfs.VirtualFileManager#findFileByUrl(String)} <br>
55    *
56    * Note that list of roots is project-dependent.
57    *
58    * @param rootType the type of roots which should be returned.
59    * @return the list of roots of the specified type.
60    */
61   @NotNull
62   String[] getUrls(@NotNull OrderRootType rootType);
63
64   /**
65    * Returns the user-visible name of this OrderEntry.
66    *
67    * @return name of this OrderEntry to be shown to user.
68    */
69   @NotNull
70   String getPresentableName();
71
72   /**
73    * Checks whether this order entry is invalid for some reason. Note that entry being valid
74    * does not necessarily mean that all its roots are valid.
75    *
76    * @return true if entry is valid, false otherwise.
77    */
78   boolean isValid();
79
80   /**
81    * Returns the module to which the entry belongs.
82    *
83    * @return the module instance.
84    */
85   @NotNull
86   Module getOwnerModule();
87
88   /**
89    * Accepts the specified order entries visitor.
90    *
91    * @param policy       the visitor to accept.
92    * @param initialValue the default value to be returned by the visit process.
93    * @return the value returned by the visitor.
94    */
95   <R> R accept(@NotNull RootPolicy<R> policy, @Nullable R initialValue);
96 }