View Javadoc

1   /*
2    * Grapht, an open source dependency injector.
3    * Copyright 2014-2015 various contributors (see CONTRIBUTORS.txt)
4    * Copyright 2010-2014 Regents of the University of Minnesota
5    *
6    * This program is free software; you can redistribute it and/or modify
7    * it under the terms of the GNU Lesser General Public License as
8    * published by the Free Software Foundation; either version 2.1 of the
9    * License, or (at your option) any later version.
10   *
11   * This program is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
13   * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
14   * details.
15   *
16   * You should have received a copy of the GNU General Public License along with
17   * this program; if not, write to the Free Software Foundation, Inc., 51
18   * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19   */
20  package org.grouplens.grapht.annotation;
21  
22  import java.lang.annotation.*;
23  
24  /**
25   * Marks a qualifier annotation as an alias for another qualifier.  Useful for deprecating
26   * qualifiers.
27   * <p>
28   * The aliased qualifier (the one bearing this annotation) is treated exactly as the qualifier it
29   * aliases.  Aliases are recursive and transitive, and the alias annotations are followed until an
30   * unaliased qualifier is found.  Circular alias loops are not allowed.
31   */
32  @Documented
33  @Retention(RetentionPolicy.RUNTIME)
34  @Target(ElementType.ANNOTATION_TYPE)
35  public @interface AliasFor {
36      /**
37       * Get the target of this alias annotation.
38       * @return The annotation for which the annotated annotation is an alias.
39       */
40      Class<? extends Annotation> value();
41  }