98df2e44e4c790c005427be1dd737e3eaa190770
[idea/community.git] / java / java-psi-api / src / com / intellij / psi / augment / PsiAugmentProvider.java
1 /*
2  * Copyright 2000-2010 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.psi.augment;
17
18 import com.intellij.openapi.diagnostic.Logger;
19 import com.intellij.openapi.extensions.ExtensionPointName;
20 import com.intellij.openapi.extensions.Extensions;
21 import com.intellij.psi.PsiElement;
22 import com.intellij.psi.PsiType;
23 import com.intellij.psi.PsiTypeElement;
24 import org.jetbrains.annotations.NotNull;
25 import org.jetbrains.annotations.Nullable;
26
27 import java.util.ArrayList;
28 import java.util.Collections;
29 import java.util.List;
30
31
32 public abstract class PsiAugmentProvider {
33   private static final Logger LOG = Logger.getInstance("#" + PsiAugmentProvider.class.getName());
34   public static final ExtensionPointName<PsiAugmentProvider> EP_NAME = ExtensionPointName.create("com.intellij.lang.psiAugmentProvider");
35
36   @NotNull
37   public abstract <Psi extends PsiElement> List<Psi> getAugments(@NotNull PsiElement element, @NotNull Class<Psi> type);
38
39   @NotNull
40   public static <Psi extends PsiElement> List<Psi> collectAugments(@NotNull final PsiElement element, @NotNull final Class<Psi> type) {
41     List<Psi> result = Collections.emptyList();
42     for (PsiAugmentProvider provider : Extensions.getExtensions(EP_NAME)) {
43       List<Psi> augments = provider.getAugments(element, type);
44       if (!augments.isEmpty()) {
45         if (result.isEmpty()) result = new ArrayList<Psi>(augments.size());
46         result.addAll(augments);
47       }
48     }
49
50     return result;
51   }
52
53   /**
54    * Extends {@link PsiTypeElement#getType()} so type could be retrieved from external place
55    * e.g. from variable initializer in lombok case (http://projectlombok.org/features/val.html)
56    * 
57    * @param typeElement place where inference takes place, 
58    *                    also nested PsiTypeElement-s (e.g. for List<String> PsiTypeElements corresponding to both List and String would be suggested)
59    * @return inferred type or null, if inference is not applicable
60    */
61   @Nullable
62   protected PsiType inferType(PsiTypeElement typeElement) {
63     return null;
64   }
65
66   @Nullable
67   public static PsiType getInferredType(PsiTypeElement typeElement) {
68     for (PsiAugmentProvider provider : Extensions.getExtensions(EP_NAME)) {
69       try {
70         final PsiType type = provider.inferType(typeElement);
71         if (type != null) {
72           return type;
73         }
74       }
75       catch (Exception e) {
76         LOG.error("provider: " + provider, e);
77       }
78     }
79     return null;
80   }
81 }