jdk/src/share/classes/java/lang/annotation/Target.java
author jfranck
Mon, 30 Sep 2013 11:18:18 +0200
changeset 20481 2735b307d256
parent 18546 862067c6481c
child 21828 5c9519eb783c
permissions -rw-r--r--
8007072: Update Core Reflection for Type Annotations to match latest spec 8022324: j.l.Class.getAnnotatedInterfaces() for array type returns wrong value 8024915: j.l.r.Executable.getAnnotatedReceiverType() should return null for static methods Summary: Update javadoc and implementation of reflection for type annotations to match latest spec Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
16026
91424708dab5 6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents: 5506
diff changeset
     2
 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.lang.annotation;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * Indicates the kinds of program element to which an annotation type
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * is applicable.  If a Target meta-annotation is not present on an
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * annotation type declaration, the declared type may be used on any
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * program element.  If such a meta-annotation is present, the compiler
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * will enforce the specified usage restriction.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * For example, this meta-annotation indicates that the declared type is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * itself a meta-annotation type.  It can only be used on annotation type
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * declarations:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 *    &#064;Target(ElementType.ANNOTATION_TYPE)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 *    public &#064;interface MetaAnnotationType {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *        ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 *    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * This meta-annotation indicates that the declared type is intended solely
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * for use as a member type in complex annotation type declarations.  It
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * cannot be used to annotate anything directly:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 *    &#064;Target({})
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 *    public &#064;interface MemberType {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 *        ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 *    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * </pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * It is a compile-time error for a single ElementType constant to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * appear more than once in a Target annotation.  For example, the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * following meta-annotation is illegal:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 *    &#064;Target({ElementType.FIELD, ElementType.METHOD, ElementType.FIELD})
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 *    public &#064;interface Bogus {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 *        ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 *    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
 * </pre>
16026
91424708dab5 6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents: 5506
diff changeset
    62
 *
91424708dab5 6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents: 5506
diff changeset
    63
 * @since 1.5
91424708dab5 6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents: 5506
diff changeset
    64
 * @jls 9.6.3.1 @Target
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
@Documented
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
@Retention(RetentionPolicy.RUNTIME)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
@Target(ElementType.ANNOTATION_TYPE)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
public @interface Target {
18546
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    70
    /**
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    71
     * Returns an array of the kinds of elements an annotation type
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    72
     * can be applied to.
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    73
     * @return an array of the kinds of elements an annotation type
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    74
     * can be applied to
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    75
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    ElementType[] value();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
}