replaced <code></code> with more concise {@code}
[idea/community.git] / platform / platform-impl / src / com / intellij / openapi / options / SchemeImporterEP.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.options;
17
18 import com.intellij.openapi.extensions.AbstractExtensionPointBean;
19 import com.intellij.openapi.extensions.ExtensionPointName;
20 import com.intellij.openapi.util.LazyInstance;
21 import com.intellij.util.xmlb.annotations.Attribute;
22 import org.jetbrains.annotations.NotNull;
23 import org.jetbrains.annotations.Nullable;
24
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.List;
28
29 /**
30  * @author Rustam Vishnyakov
31  */
32 public class SchemeImporterEP <S extends Scheme> extends AbstractExtensionPointBean {
33   public static final ExtensionPointName<SchemeImporterEP> EP_NAME = ExtensionPointName.create("com.intellij.schemeImporter");
34
35   @Attribute("name")
36   public String name;
37
38   @Attribute("schemeClass")
39   public String schemeClass;
40
41   @Attribute("implementationClass")
42   public String implementationClass;
43
44   private final LazyInstance<SchemeImporter<S>> myImporterInstance = new LazyInstance<SchemeImporter<S>>() {
45     @Override
46     protected Class<SchemeImporter<S>> getInstanceClass() throws ClassNotFoundException {
47       return findClass(implementationClass);
48     }
49   };
50   
51   public SchemeImporter<S> getInstance() {
52     return myImporterInstance.getValue();
53   }
54
55   /**
56    * Finds extensions supporting the given {@code schemeClass}
57    * @param schemeClass The class of the scheme to search extensions for.
58    * @return A collection of importers capable of importing schemes of the given class. An empty collection is returned if there are
59    *         no matching importers.
60    */
61   @NotNull
62   public static <S extends Scheme> Collection<SchemeImporterEP<S>> getExtensions(Class<S> schemeClass) {
63     List<SchemeImporterEP<S>> importers = new ArrayList<>();
64     for (SchemeImporterEP<?> importerEP : EP_NAME.getExtensions()) {
65       if (schemeClass.getName().equals(importerEP.schemeClass)) {
66         //noinspection unchecked
67         importers.add((SchemeImporterEP<S>)importerEP);
68       }
69     }
70     return importers;
71   }
72
73
74   /**
75    * Find an importer for the given name and scheme class. It is allowed for importers to have the same name but different scheme classes.
76    * @param name        The importer name as defined in plug-in configuration.
77    * @param schemeClass The scheme class the importer has to support.
78    * @return The found importer or null if there are no importers for the given name and scheme class.
79    */
80   @Nullable
81   public static <S extends Scheme> SchemeImporter<S> getImporter(@NotNull String name, Class<S> schemeClass) {
82     for (SchemeImporterEP<S> importerEP : getExtensions(schemeClass)) {
83       if (name.equals(importerEP.name)) {
84         return importerEP.getInstance();
85       }
86     }
87     return null;
88   }
89
90 }