jdk/src/java.base/share/classes/java/lang/annotation/Target.java
author chegar
Sun, 17 Aug 2014 15:54:13 +0100
changeset 25859 3317bb8137f4
parent 21828 jdk/src/share/classes/java/lang/annotation/Target.java@5c9519eb783c
child 29232 1e69d3a5a305
permissions -rw-r--r--
8054834: Modular Source Code Reviewed-by: alanb, chegar, ihse, mduigou Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, chris.hegarty@oracle.com, erik.joelsson@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, magnus.ihse.bursie@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, paul.sandoz@oracle.com
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
/**
21828
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    29
 * Indicates the contexts in which an annotation type is applicable. The
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    30
 * declaration contexts and type contexts in which an annotation type may be
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    31
 * applicable are specified in JLS 9.6.4.1, and denoted in source code by enum
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    32
 * constants of {@link ElementType java.lang.annotation.ElementType}.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *
21828
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    34
 * <p>If an {@code @Target} meta-annotation is not present on an annotation type
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    35
 * {@code T} , then an annotation of type {@code T} may be written as a
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    36
 * modifier for any declaration except a type parameter declaration.
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    37
 *
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    38
 * <p>If an {@code @Target} meta-annotation is present, the compiler will enforce
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    39
 * the usage restrictions indicated by {@code ElementType}
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    40
 * enum constants, in line with JLS 9.7.4.
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    41
 *
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    42
 * <p>For example, this {@code @Target} meta-annotation indicates that the
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    43
 * declared type is itself a meta-annotation type.  It can only be used on
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    44
 * annotation type declarations:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 *    &#064;Target(ElementType.ANNOTATION_TYPE)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 *    public &#064;interface MetaAnnotationType {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 *        ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 *    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * </pre>
21828
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    51
 *
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    52
 * <p>This {@code @Target} meta-annotation indicates that the declared type is
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    53
 * intended solely for use as a member type in complex annotation type
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    54
 * declarations.  It cannot be used to annotate anything directly:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 *    &#064;Target({})
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 *    public &#064;interface MemberType {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 *        ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
 *    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 * </pre>
21828
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    61
 *
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    62
 * <p>It is a compile-time error for a single {@code ElementType} constant to
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    63
 * appear more than once in an {@code @Target} annotation.  For example, the
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    64
 * following {@code @Target} meta-annotation is illegal:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
 * <pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
 *    &#064;Target({ElementType.FIELD, ElementType.METHOD, ElementType.FIELD})
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
 *    public &#064;interface Bogus {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
 *        ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
 *    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
 * </pre>
16026
91424708dab5 6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents: 5506
diff changeset
    71
 *
91424708dab5 6556996: (ann spec) SuppressWarnings strings should be documented
darcy
parents: 5506
diff changeset
    72
 * @since 1.5
21828
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    73
 * @jls 9.6.4.1 @Target
5c9519eb783c 8027413: Clarify javadoc for j.l.a.Target and j.l.a.ElementType
jfranck
parents: 18546
diff changeset
    74
 * @jls 9.7.4 Where Annotations May Appear
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
@Documented
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
@Retention(RetentionPolicy.RUNTIME)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
@Target(ElementType.ANNOTATION_TYPE)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
public @interface Target {
18546
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    80
    /**
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    81
     * 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
    82
     * can be applied to.
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    83
     * @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
    84
     * can be applied to
862067c6481c 8017550: Fix doclint issues in java.lang and subpackages
darcy
parents: 16026
diff changeset
    85
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    ElementType[] value();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
}