WEB-46403 Improve HTML lexer API for easier consumption by framework specific support
[idea/community.git] / platform / projectModel-api / src / com / intellij / openapi / roots / OrderEnumerationHandler.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.openapi.roots;
17
18 import com.intellij.openapi.extensions.ExtensionPointName;
19 import com.intellij.openapi.module.Module;
20 import org.jetbrains.annotations.ApiStatus;
21 import org.jetbrains.annotations.Contract;
22 import org.jetbrains.annotations.NotNull;
23
24 import java.util.Collection;
25
26 @ApiStatus.OverrideOnly
27 public abstract class OrderEnumerationHandler {
28   public static final ExtensionPointName<Factory> EP_NAME =
29     ExtensionPointName.create("com.intellij.orderEnumerationHandlerFactory");
30
31   public abstract static class Factory {
32     @Contract(pure = true)
33     public abstract boolean isApplicable(@NotNull Module module);
34
35     @NotNull
36     @Contract(pure = true)
37     public abstract OrderEnumerationHandler createHandler(@NotNull Module module);
38   }
39
40   public enum AddDependencyType {ADD, DO_NOT_ADD, DEFAULT}
41
42   @NotNull
43   public AddDependencyType shouldAddDependency(@NotNull OrderEntry orderEntry,
44                                                @NotNull OrderEnumeratorSettings settings) {
45     return AddDependencyType.DEFAULT;
46   }
47
48   public boolean shouldAddRuntimeDependenciesToTestCompilationClasspath() {
49     return false;
50   }
51
52   public boolean shouldIncludeTestsFromDependentModulesToTestClasspath() {
53     return true;
54   }
55
56   public boolean shouldProcessDependenciesRecursively() {
57     return true;
58   }
59
60   public boolean addCustomRootsForLibrary(@NotNull OrderEntry forOrderEntry,
61                                           @NotNull OrderRootType type,
62                                           @NotNull Collection<String> urls) {
63     return false;
64   }
65
66   public boolean addCustomModuleRoots(@NotNull OrderRootType type,
67                                       @NotNull ModuleRootModel rootModel,
68                                       @NotNull Collection<String> result,
69                                       boolean includeProduction,
70                                       boolean includeTests) {
71     return false;
72   }
73 }