src/share/classes/com/sun/javadoc/AnnotationDesc.java

Tue, 24 Dec 2013 09:17:37 -0800

author
ksrini
date
Tue, 24 Dec 2013 09:17:37 -0800
changeset 2227
998b10c43157
parent 1477
8c0c63a6e3b7
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com

     1 /*
     2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Oracle in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  * or visit www.oracle.com if you need additional information or have any
    23  * questions.
    24  */
    26 package com.sun.javadoc;
    29 /**
    30  * Represents an annotation.
    31  * An annotation associates a value with each element of an annotation type.
    32  *
    33  * @author Scott Seligman
    34  * @since 1.5
    35  */
    36 public interface AnnotationDesc {
    38     /**
    39      * Returns the annotation type of this annotation.
    40      *
    41      * @return the annotation type of this annotation.
    42      */
    43     AnnotationTypeDoc annotationType();
    45     /**
    46      * Returns this annotation's elements and their values.
    47      * Only those explicitly present in the annotation are
    48      * included, not those assuming their default values.
    49      * Returns an empty array if there are none.
    50      *
    51      * @return this annotation's elements and their values.
    52      */
    53     ElementValuePair[] elementValues();
    55     /**
    56      * Check for the synthesized bit on the annotation.
    57      *
    58      * @return true if the annotation is synthesized.
    59      */
    60     boolean isSynthesized();
    62     /**
    63      * Represents an association between an annotation type element
    64      * and one of its values.
    65      *
    66      * @author Scott Seligman
    67      * @since 1.5
    68      */
    69     public interface ElementValuePair {
    71         /**
    72          * Returns the annotation type element.
    73          *
    74          * @return the annotation type element.
    75          */
    76         AnnotationTypeElementDoc element();
    78         /**
    79          * Returns the value associated with the annotation type element.
    80          *
    81          * @return the value associated with the annotation type element.
    82          */
    83         AnnotationValue value();
    84     }
    85 }

mercurial