[facets API] mark some interfaces in Facets API as NonExtendable
[idea/community.git] / platform / lang-api / src / com / intellij / facet / FacetManager.java
1 // Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
2
3 package com.intellij.facet;
4
5 import com.intellij.openapi.module.Module;
6 import com.intellij.util.messages.Topic;
7 import org.jetbrains.annotations.ApiStatus;
8 import org.jetbrains.annotations.NotNull;
9 import org.jetbrains.annotations.Nullable;
10
11 /**
12  * @author nik
13  */
14 @ApiStatus.NonExtendable
15 public abstract class FacetManager implements FacetModel {
16   public static final Topic<FacetManagerListener> FACETS_TOPIC = Topic.create("facet changes", FacetManagerListener.class, Topic.BroadcastDirection.TO_PARENT);
17
18   public static FacetManager getInstance(@NotNull Module module) {
19     return module.getComponent(FacetManager.class);
20   }
21
22   /**
23    * Creates the interface for modifying set of facets in the module. Call {@link ModifiableFacetModel#commit()} when modification is finished
24    * @return the modifiable facet model
25    */
26   @NotNull
27   public abstract ModifiableFacetModel createModifiableModel();
28
29   @NotNull
30   public abstract <F extends Facet<?>, C extends FacetConfiguration> F createFacet(@NotNull FacetType<F, C> type, @NotNull String name,
31                                                                                    @NotNull C configuration, @Nullable Facet<?> underlying);
32
33
34   @NotNull
35   public abstract <F extends Facet<?>, C extends FacetConfiguration> F createFacet(@NotNull FacetType<F, C> type, @NotNull String name,
36                                                                                    @Nullable Facet<?> underlying);
37
38   @NotNull
39   public abstract <F extends Facet<?>, C extends FacetConfiguration> F addFacet(@NotNull FacetType<F, C> type, @NotNull String name,
40                                                                                    @Nullable Facet<?> underlying);
41
42 }