1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/*
* Copyright 2000-2009 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.intellij.openapi.roots;
import com.intellij.openapi.extensions.ExtensionPointName;
import com.intellij.openapi.extensions.Extensions;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import java.util.*;
/**
* Root types that can be queried from OrderEntry.
* @see OrderEntry
* @author dsl
*/
public class OrderRootType {
private final String myName;
private static boolean ourExtensionsLoaded = false;
public static final ExtensionPointName<OrderRootType> EP_NAME = ExtensionPointName.create("com.intellij.orderRootType");
protected static PersistentOrderRootType[] ourPersistentOrderRootTypes = new PersistentOrderRootType[0];
protected OrderRootType(@NonNls String name) {
myName = name;
}
/**
* Classpath without output directories for modules.
* Includes:
* <li> classes roots for libraries and jdk
* <li> recursively for module dependencies: only exported items
*/
public static final OrderRootType CLASSES = new PersistentOrderRootType("CLASSES", "classPath", null, "classPathEntry");
/**
* Sources.
* Includes:
* <li> production and test source roots for modules
* <li> source roots for libraries and jdk
* <li> recursively for module dependencies: only exported items
*/
public static final OrderRootType SOURCES = new PersistentOrderRootType("SOURCES", "sourcePath", null, "sourcePathEntry");
/**
* Documentation.
* Generic documentation order root type
*/
public static final OrderRootType DOCUMENTATION = new DocumentationRootType();
/**
* A temporary solution to exclude DOCUMENTATION from getAllTypes() and handle it only in special
* cases if supported by LibraryType.
*/
public static class DocumentationRootType extends OrderRootType {
public DocumentationRootType() {
super("DOCUMENTATION");
}
@Override
public boolean skipWriteIfEmpty() {
return true;
}
public String getSdkRootName() {
return "documentation";
}
}
public String name() {
return myName;
}
/**
* Whether this root type should be skipped when writing a Library if the root type doesn't contain
* any roots.
*
* @return true if empty root type should be skipped, false otherwise.
*/
public boolean skipWriteIfEmpty() {
return false;
}
public static synchronized OrderRootType[] getAllTypes() {
return getAllPersistentTypes();
}
public static PersistentOrderRootType[] getAllPersistentTypes() {
if (!ourExtensionsLoaded) {
ourExtensionsLoaded = true;
Extensions.getExtensions(EP_NAME);
}
return ourPersistentOrderRootTypes;
}
public static List<PersistentOrderRootType> getSortedRootTypes() {
List<PersistentOrderRootType> allTypes = new ArrayList<PersistentOrderRootType>();
Collections.addAll(allTypes, getAllPersistentTypes());
Collections.sort(allTypes, new Comparator<PersistentOrderRootType>() {
public int compare(@NotNull final PersistentOrderRootType o1, @NotNull final PersistentOrderRootType o2) {
return o1.name().compareToIgnoreCase(o2.name());
}
});
return allTypes;
}
protected static <T> T getOrderRootType(final Class<? extends T> orderRootTypeClass) {
OrderRootType[] rootTypes = Extensions.getExtensions(EP_NAME);
for(OrderRootType rootType: rootTypes) {
if (orderRootTypeClass.isInstance(rootType)) {
//noinspection unchecked
return (T)rootType;
}
}
assert false : "Root type "+orderRootTypeClass+" not found. All roots: "+ Arrays.asList(rootTypes);
return null;
}
public final int hashCode() {
return super.hashCode();
}
public final boolean equals(Object obj) {
return super.equals(obj);
}
@Override
public String toString() {
return "Root " + name();
}
}
|
