xml/dom-openapi/src/com/intellij/util/xml/CustomReferenceConverter.java

   1 /*
   2  * Copyright 2000-2009 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.util.xml;
  17
  18 import com.intellij.psi.PsiReference;
  19 import com.intellij.psi.PsiElement;
  20 import org.jetbrains.annotations.NotNull;
  21
  22 /**
  23  * Can be implemented by {@link com.intellij.util.xml.Converter} instance, or used with
  24  * {@link @com.intellij.util.xml.Referencing} annotation.
  25  *
  26  * @author peter
  27  */
  28 public interface CustomReferenceConverter<T> {
  29
  30   /**
  31    * Will be called on creating {@link com.intellij.psi.PsiReference}s for {@link com.intellij.util.xml.GenericDomValue}
  32    * Returned {@link com.intellij.psi.PsiReference}s should be soft ({@link com.intellij.psi.PsiReference#isSoft()} should return <code>true</code>).
  33    * To highlight unresolved references, create a {@link com.intellij.util.xml.highlighting.DomElementsInspection} and register it.
  34    *
  35    * @param value GenericDomValue in question
  36    * @param element corresponding PSI element
  37    * @param context {@link com.intellij.util.xml.ConvertContext}
  38    * @return custom {@link com.intellij.psi.PsiReference}s for the value
  39    */
  40   @NotNull
  41   PsiReference[] createReferences(GenericDomValue<T> value, PsiElement element, ConvertContext context);
  42 }