replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / openapi / fileEditor / ex / FileEditorProviderManager.java
1 /*
2  * Copyright 2000-2013 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.fileEditor.ex;
17
18 import com.intellij.openapi.components.ServiceManager;
19 import com.intellij.openapi.fileEditor.FileEditorProvider;
20 import com.intellij.openapi.project.Project;
21 import com.intellij.openapi.vfs.VirtualFile;
22 import org.jetbrains.annotations.NotNull;
23 import org.jetbrains.annotations.Nullable;
24
25 /**
26  * @author Anton Katilin
27  * @author Vladimir Kondratyev
28  */
29 public abstract class FileEditorProviderManager{
30   public static FileEditorProviderManager getInstance(){
31     return ServiceManager.getService(FileEditorProviderManager.class);
32   }
33
34   /**
35    * @param file cannot be {@code null}
36    *
37    * @return array of all editors providers that can create editor
38    * for the specified {@code file}. The method returns
39    * an empty array if there are no such providers. Please note that returned array
40    * is constructed with respect to editor policies.
41    */
42   @NotNull
43   public abstract FileEditorProvider[] getProviders(@NotNull Project project, @NotNull VirtualFile file);
44
45   /**
46    * @return may be null
47    */
48   @Nullable
49   public abstract FileEditorProvider getProvider(@NotNull String editorTypeId);
50 }