xml/dom-openapi/src/com/intellij/util/xml/Convert.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 java.lang.annotation.Retention;
  19 import java.lang.annotation.RetentionPolicy;
  20 import java.lang.annotation.Target;
  21 import java.lang.annotation.ElementType;
  22
  23 /**
  24  * All DOM methods that return something nontrivial, not String, Integer, Boolean, PsiClass, PsiType, or {@link com.intellij.util.xml.GenericValue}
  25  * parameterized with all these elements, should be annotated with this annotation. The {@link #value()} parameter should
  26  * specify {@link com.intellij.util.xml.Converter} class able to convert this custom type to and from {@link String}.
  27  * Also DOM interfaces can be annotated, which will mean that all tag value methods inside will have the specified converter.
  28  *
  29  * @author peter
  30  */
  31 @Retention(RetentionPolicy.RUNTIME)
  32 @Target({ElementType.METHOD, ElementType.TYPE})
  33 public @interface Convert {
  34   /**
  35    * @return Converter class
  36    */
  37   Class<? extends Converter> value();
  38
  39   /**
  40    * @return whether the corresponding XML reference to be soft. Soft references are not highlighted as errors, if unresolved.
  41    */
  42   boolean soft() default false;
  43 }