dom/openapi/src/com/intellij/util/xml/PropertyAccessor.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 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  * Annotates DOM methods that are shoutcuts to long call chains. For example, if you often need
  25  * to write getFoo().getBar().getZip(), you can instead create a method getFBZ() and annotate it
  26  * with @PropertyAccessor({"foo", "bar", "zip"}).
  27  *
  28  * @author peter
  29  */
  30 @Retention(RetentionPolicy.RUNTIME)
  31 @Target({ElementType.METHOD})
  32 public @interface PropertyAccessor {
  33   /**
  34    * @return list of property names corresponding to methods you want to replace calls to
  35    */
  36   String[] value();
  37 }