[facets API] mark some interfaces in Facets API as NonExtendable
[idea/community.git] / platform / lang-api / src / com / intellij / facet / ui / FacetEditorContext.java
1 /*
2  * Copyright 2000-2019 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
17 package com.intellij.facet.ui;
18
19 import com.intellij.facet.Facet;
20 import com.intellij.ide.util.projectWizard.ModuleBuilder;
21 import com.intellij.ide.util.projectWizard.WizardContext;
22 import com.intellij.openapi.module.Module;
23 import com.intellij.openapi.project.Project;
24 import com.intellij.openapi.roots.ModifiableRootModel;
25 import com.intellij.openapi.roots.ModuleRootModel;
26 import com.intellij.openapi.roots.OrderRootType;
27 import com.intellij.openapi.roots.libraries.Library;
28 import com.intellij.openapi.roots.ui.configuration.FacetsProvider;
29 import com.intellij.openapi.roots.ui.configuration.ModulesProvider;
30 import com.intellij.openapi.util.UserDataHolder;
31 import com.intellij.openapi.vfs.VirtualFile;
32 import org.jetbrains.annotations.ApiStatus;
33 import org.jetbrains.annotations.NonNls;
34 import org.jetbrains.annotations.NotNull;
35 import org.jetbrains.annotations.Nullable;
36
37 /**
38  * @author nik
39  */
40 @ApiStatus.NonExtendable
41 public interface FacetEditorContext extends UserDataHolder {
42
43   @NotNull
44   Project getProject();
45
46   @Nullable
47   Library findLibrary(@NotNull String name);
48
49   /**
50    * @deprecated always {@code null}
51    */
52   @Deprecated
53   @Nullable
54   ModuleBuilder getModuleBuilder();
55
56   boolean isNewFacet();
57
58   @NotNull
59   Facet getFacet();
60
61   @NotNull
62   Module getModule();
63
64   @Nullable
65   Facet getParentFacet();
66
67   @NotNull
68   FacetsProvider getFacetsProvider();
69
70   @NotNull
71   ModulesProvider getModulesProvider();
72
73   @NotNull
74   ModifiableRootModel getModifiableRootModel();
75
76   @NotNull
77   ModuleRootModel getRootModel();
78
79   Library[] getLibraries();
80
81   /**
82    * @deprecated always {@code null}
83    */
84   @Deprecated
85   @Nullable
86   WizardContext getWizardContext();
87
88   Library createProjectLibrary(@NonNls String name, final VirtualFile[] roots, final VirtualFile[] sources);
89
90   VirtualFile[] getLibraryFiles(Library library, OrderRootType rootType);
91
92   @NotNull
93   String getFacetName();
94 }