lang-api/src/com/intellij/psi/PsiReferenceRegistrar.java

   1 /*
   2  * Copyright (c) 2000-2005 by JetBrains s.r.o. All Rights Reserved.
   3  * Use is subject to license terms.
   4  */
   5 package com.intellij.psi;
   6
   7 import com.intellij.openapi.project.Project;
   8 import com.intellij.patterns.ElementPattern;
   9 import com.intellij.patterns.PlatformPatterns;
  10 import com.intellij.patterns.StandardPatterns;
  11 import com.intellij.pom.references.PomReferenceProvider;
  12 import org.jetbrains.annotations.NotNull;
  13
  14 /**
  15  * @author peter
  16  */
  17 public abstract class PsiReferenceRegistrar {
  18   public static final double DEFAULT_PRIORITY = 0.0;
  19   public static final double HIGHER_PRIORITY = 100.0;
  20   public static final double LOWER_PRIORITY = -100.0;
  21
  22   /**
  23    * Register reference provider with default priority ({@link #DEFAULT_PRIORITY})
  24    * @param pattern reference place description. See {@link StandardPatterns}, {@link PlatformPatterns} and their extenders
  25    * @param provider
  26    */
  27   public void registerReferenceProvider(@NotNull ElementPattern<? extends PsiElement> pattern, @NotNull PsiReferenceProvider provider) {
  28     registerReferenceProvider(pattern, provider, DEFAULT_PRIORITY);
  29   }
  30
  31
  32   /**
  33    * Register reference provider
  34    * @param pattern reference place description. See {@link StandardPatterns}, {@link PlatformPatterns} and their extenders
  35    * @param provider
  36    * @param priority @see DEFAULT_PRIORITY, HIGHER_PRIORITY, LOWER_PRIORITY
  37    */
  38   public abstract <T extends PsiElement> void registerReferenceProvider(@NotNull ElementPattern<T> pattern, @NotNull PsiReferenceProvider provider, double priority);
  39
  40   public <T extends PsiElement> void registerReferenceProvider(@NotNull ElementPattern<T> pattern, @NotNull PomReferenceProvider<T> provider) {
  41     registerReferenceProvider(pattern, provider, DEFAULT_PRIORITY);
  42   }
  43
  44   public abstract <T extends PsiElement> void registerReferenceProvider(@NotNull ElementPattern<T> pattern, @NotNull PomReferenceProvider<T> provider, double priority);
  45
  46   /**
  47    * Return the project to register providers for.
  48    * @return project or null, if POM references are registered
  49    */
  50   @Deprecated
  51   public abstract Project getProject();
  52 }