replaced <code></code> with more concise {@code}
[idea/community.git] / platform / editor-ui-api / src / com / intellij / ide / structureView / StructureViewFactory.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.ide.structureView;
17
18 import com.intellij.openapi.components.ServiceManager;
19 import com.intellij.openapi.fileEditor.FileEditor;
20 import com.intellij.openapi.project.Project;
21 import org.jetbrains.annotations.NotNull;
22
23 /**
24  * Factory interface for creating instances of the standard structure view component.
25  */
26 public abstract class StructureViewFactory {
27   /**
28    * Creates a structure view component instance for the specified editor.
29    *
30    * @param fileEditor the editor to which the structure view is linked.
31    * @param treeModel  the model defining the data shown in the structure view.
32    * @param project    the project containing the file for which the structure view is requested.
33    * @return the structure view instance.
34    */
35   @NotNull
36   public abstract StructureView createStructureView(FileEditor fileEditor,
37                                                     @NotNull StructureViewModel treeModel,
38                                                     @NotNull Project project);
39
40   /**
41    * Creates a structure view component instance for the specified editor.
42    *
43    * @param fileEditor the editor to which the structure view is linked.
44    * @param treeModel  the model defining the data shown in the structure view.
45    * @param project    the project containing the file for which the structure view is requested.
46    * @param showRootNode pass {@code false} if root node of the structure built should not actually be shown in result tree.
47    * @return the structure view instance.
48    */
49   @NotNull
50   public abstract StructureView createStructureView(FileEditor fileEditor,
51                                                     @NotNull StructureViewModel treeModel,
52                                                     @NotNull Project project,
53                                                     boolean showRootNode);
54
55   public static StructureViewFactory getInstance(Project project) {
56     return ServiceManager.getService(project, StructureViewFactory.class);
57   }
58 }