openapi/src/com/intellij/util/xml/ExtendClass.java

   1 /*
   2  * Copyright 2000-2007 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
  17 package com.intellij.util.xml;
  18
  19 import java.lang.annotation.Retention;
  20 import java.lang.annotation.RetentionPolicy;
  21
  22 /**
  23  * Annotates DOM methods that return either {@link com.intellij.psi.PsiClass} or
  24  * {@link com.intellij.util.xml.GenericDomValue}<{@link com.intellij.psi.PsiClass}>.
  25  * Specifies that the references class should extend some other class (or implement interface).
  26  * If this doesn't happen, error will appear.
  27  *
  28  * @author Dmitry Avdeev
  29  */
  30 @Retention(RetentionPolicy.RUNTIME)
  31 public @interface ExtendClass {
  32
  33   /**
  34    * @return qualified name of the base class
  35    */
  36   String value() default "";
  37
  38   /**
  39    * @return states that the class should be concrete and have public default constructor.
  40    */
  41   boolean instantiatable() default true;
  42
  43   /**
  44    * @return states that the class implements "decorator" pattern, i.e. it should have constructor with
  45    * one parameter of the same type
  46    */
  47   boolean canBeDecorator() default false;
  48
  49   boolean allowEmpty() default false;
  50
  51   boolean allowAbstract() default true;
  52
  53   boolean allowInterface() default true;
  54 }