emul/mini/src/main/java/java/lang/annotation/Target.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Wed, 23 Jan 2013 20:39:23 +0100
branchemul
changeset 554 05224402145d
parent 68 emul/src/main/java/java/lang/annotation/Target.java@a2924470187b
permissions -rw-r--r--
First attempt to separate 'mini' profile from the rest of JDK APIs
jaroslav@68
     1
/*
jaroslav@68
     2
 * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
jaroslav@68
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@68
     4
 *
jaroslav@68
     5
 * This code is free software; you can redistribute it and/or modify it
jaroslav@68
     6
 * under the terms of the GNU General Public License version 2 only, as
jaroslav@68
     7
 * published by the Free Software Foundation.  Oracle designates this
jaroslav@68
     8
 * particular file as subject to the "Classpath" exception as provided
jaroslav@68
     9
 * by Oracle in the LICENSE file that accompanied this code.
jaroslav@68
    10
 *
jaroslav@68
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@68
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@68
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@68
    14
 * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@68
    15
 * accompanied this code).
jaroslav@68
    16
 *
jaroslav@68
    17
 * You should have received a copy of the GNU General Public License version
jaroslav@68
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@68
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@68
    20
 *
jaroslav@68
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@68
    22
 * or visit www.oracle.com if you need additional information or have any
jaroslav@68
    23
 * questions.
jaroslav@68
    24
 */
jaroslav@68
    25
jaroslav@68
    26
package java.lang.annotation;
jaroslav@68
    27
jaroslav@68
    28
/**
jaroslav@68
    29
 * Indicates the kinds of program element to which an annotation type
jaroslav@68
    30
 * is applicable.  If a Target meta-annotation is not present on an
jaroslav@68
    31
 * annotation type declaration, the declared type may be used on any
jaroslav@68
    32
 * program element.  If such a meta-annotation is present, the compiler
jaroslav@68
    33
 * will enforce the specified usage restriction.
jaroslav@68
    34
 *
jaroslav@68
    35
 * For example, this meta-annotation indicates that the declared type is
jaroslav@68
    36
 * itself a meta-annotation type.  It can only be used on annotation type
jaroslav@68
    37
 * declarations:
jaroslav@68
    38
 * <pre>
jaroslav@68
    39
 *    &#064;Target(ElementType.ANNOTATION_TYPE)
jaroslav@68
    40
 *    public &#064;interface MetaAnnotationType {
jaroslav@68
    41
 *        ...
jaroslav@68
    42
 *    }
jaroslav@68
    43
 * </pre>
jaroslav@68
    44
 * This meta-annotation indicates that the declared type is intended solely
jaroslav@68
    45
 * for use as a member type in complex annotation type declarations.  It
jaroslav@68
    46
 * cannot be used to annotate anything directly:
jaroslav@68
    47
 * <pre>
jaroslav@68
    48
 *    &#064;Target({})
jaroslav@68
    49
 *    public &#064;interface MemberType {
jaroslav@68
    50
 *        ...
jaroslav@68
    51
 *    }
jaroslav@68
    52
 * </pre>
jaroslav@68
    53
 * It is a compile-time error for a single ElementType constant to
jaroslav@68
    54
 * appear more than once in a Target annotation.  For example, the
jaroslav@68
    55
 * following meta-annotation is illegal:
jaroslav@68
    56
 * <pre>
jaroslav@68
    57
 *    &#064;Target({ElementType.FIELD, ElementType.METHOD, ElementType.FIELD})
jaroslav@68
    58
 *    public &#064;interface Bogus {
jaroslav@68
    59
 *        ...
jaroslav@68
    60
 *    }
jaroslav@68
    61
 * </pre>
jaroslav@68
    62
 */
jaroslav@68
    63
@Documented
jaroslav@68
    64
@Retention(RetentionPolicy.RUNTIME)
jaroslav@68
    65
@Target(ElementType.ANNOTATION_TYPE)
jaroslav@68
    66
public @interface Target {
jaroslav@68
    67
    ElementType[] value();
jaroslav@68
    68
}