lang-api
[idea/community.git] / platform / lang-api / src / com / intellij / facet / FacetManager.java
1 /*
2  * Copyright 2000-2007 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;
18
19 import com.intellij.openapi.module.Module;
20 import com.intellij.util.messages.Topic;
21 import org.jetbrains.annotations.NotNull;
22 import org.jetbrains.annotations.Nullable;
23
24 /**
25  * @author nik
26  */
27 public abstract class FacetManager implements FacetModel {
28   public static final Topic<FacetManagerListener> FACETS_TOPIC = Topic.create("facet changes", FacetManagerListener.class, Topic.BroadcastDirection.TO_PARENT);
29
30   public static FacetManager getInstance(@NotNull Module module) {
31     return module.getComponent(FacetManager.class);
32   }
33
34   /**
35    * Creates the interface for modifiyng set of facets in the module. Call {@link ModifiableFacetModel#commit()} when modification is finished 
36    * @return the modifiable facet model
37    */
38   @NotNull
39   public abstract ModifiableFacetModel createModifiableModel();
40
41   @NotNull
42   public abstract <F extends Facet, C extends FacetConfiguration> F createFacet(@NotNull FacetType<F, C> type, @NotNull String name,
43                                                                                    @NotNull C cofiguration, @Nullable Facet underlying);
44
45
46   @NotNull
47   public abstract <F extends Facet, C extends FacetConfiguration> F createFacet(@NotNull FacetType<F, C> type, @NotNull String name,
48                                                                                    @Nullable Facet underlying);
49
50   @NotNull
51   public abstract <F extends Facet, C extends FacetConfiguration> F addFacet(@NotNull FacetType<F, C> type, @NotNull String name, 
52                                                                                    @Nullable Facet underlying);
53
54 }