xml/dom-openapi/src/com/intellij/util/xml/highlighting/DomCustomAnnotationChecker.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.highlighting;
  17
  18 import com.intellij.util.xml.DomElement;
  19 import com.intellij.openapi.extensions.ExtensionPointName;
  20 import org.jetbrains.annotations.NotNull;
  21
  22 import java.lang.annotation.Annotation;
  23 import java.util.List;
  24
  25 /**
  26  * Basic DOM inspection (see {@link com.intellij.util.xml.highlighting.BasicDomElementsInspection})
  27  * calls this annotator on all DOM elements with the given custom user-defined annotation.
  28  *
  29  * @author peter
  30  */
  31 public abstract class DomCustomAnnotationChecker<T extends Annotation> {
  32   public static final ExtensionPointName<DomCustomAnnotationChecker> EP_NAME = ExtensionPointName.create("com.intellij.dom.customAnnotationChecker");
  33
  34   @NotNull
  35   public abstract Class<T> getAnnotationClass();
  36
  37   public abstract List<DomElementProblemDescriptor> checkForProblems(@NotNull T t, @NotNull DomElement element, @NotNull DomElementAnnotationHolder holder, @NotNull DomHighlightingHelper helper);
  38 }