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

Sat, 01 Dec 2007 00:00:00 +0000

author
duke
date
Sat, 01 Dec 2007 00:00:00 +0000
changeset 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

Initial load

     1 /*
     2  * Copyright 2003-2004 Sun Microsystems, Inc.  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.  Sun designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
    23  * have any 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();
    56     /**
    57      * Represents an association between an annotation type element
    58      * and one of its values.
    59      *
    60      * @author Scott Seligman
    61      * @since 1.5
    62      */
    63     public interface ElementValuePair {
    65         /**
    66          * Returns the annotation type element.
    67          *
    68          * @return the annotation type element.
    69          */
    70         AnnotationTypeElementDoc element();
    72         /**
    73          * Returns the value associated with the annotation type element.
    74          *
    75          * @return the value associated with the annotation type element.
    76          */
    77         AnnotationValue value();
    78     }
    79 }

mercurial