xml/dom-openapi/src/com/intellij/util/xml/Required.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
  21 /**
  22  * Specifies that the annotated method return value ({@link DomElement}) should have
  23  * a non-null XML element under itself. And some other connected properties.
  24  *
  25  * @author peter
  26  */
  27 @Retention(RetentionPolicy.RUNTIME)
  28 public @interface Required {
  29   /**
  30    * @return whether the annotated method return value ({@link DomElement}) should have
  31    * a non-null XML element under itself.
  32    */
  33   boolean value() default true;
  34
  35   /**
  36    * @return whether the annotated method return value ({@link com.intellij.util.xml.GenericDomValue})
  37    * should have non-empty value: {@link GenericDomValue#getStringValue()} != null
  38    */
  39   boolean nonEmpty() default true;
  40
  41   /**
  42    * @return whether the annotated method return value ({@link com.intellij.util.xml.GenericDomValue})
  43    * string value should be identifier: {@link GenericDomValue#getStringValue()}.
  44    *
  45    * @see com.intellij.psi.PsiNameHelper#isIdentifier(String)
  46    */
  47   boolean identifier() default false;
  48 }