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

Thu, 04 Feb 2010 10:14:28 -0800

author
jjg
date
Thu, 04 Feb 2010 10:14:28 -0800
changeset 489
4b4e282a3146
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6923080: TreeScanner.visitNewClass should scan tree.typeargs
Reviewed-by: darcy

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

mercurial