1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/src/share/classes/com/sun/javadoc/AnnotationDesc.java Sat Dec 01 00:00:00 2007 +0000 1.3 @@ -0,0 +1,79 @@ 1.4 +/* 1.5 + * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved. 1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1.7 + * 1.8 + * This code is free software; you can redistribute it and/or modify it 1.9 + * under the terms of the GNU General Public License version 2 only, as 1.10 + * published by the Free Software Foundation. Sun designates this 1.11 + * particular file as subject to the "Classpath" exception as provided 1.12 + * by Sun in the LICENSE file that accompanied this code. 1.13 + * 1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT 1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1.17 + * version 2 for more details (a copy is included in the LICENSE file that 1.18 + * accompanied this code). 1.19 + * 1.20 + * You should have received a copy of the GNU General Public License version 1.21 + * 2 along with this work; if not, write to the Free Software Foundation, 1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1.23 + * 1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or 1.26 + * have any questions. 1.27 + */ 1.28 + 1.29 +package com.sun.javadoc; 1.30 + 1.31 + 1.32 +/** 1.33 + * Represents an annotation. 1.34 + * An annotation associates a value with each element of an annotation type. 1.35 + * 1.36 + * @author Scott Seligman 1.37 + * @since 1.5 1.38 + */ 1.39 +public interface AnnotationDesc { 1.40 + 1.41 + /** 1.42 + * Returns the annotation type of this annotation. 1.43 + * 1.44 + * @return the annotation type of this annotation. 1.45 + */ 1.46 + AnnotationTypeDoc annotationType(); 1.47 + 1.48 + /** 1.49 + * Returns this annotation's elements and their values. 1.50 + * Only those explicitly present in the annotation are 1.51 + * included, not those assuming their default values. 1.52 + * Returns an empty array if there are none. 1.53 + * 1.54 + * @return this annotation's elements and their values. 1.55 + */ 1.56 + ElementValuePair[] elementValues(); 1.57 + 1.58 + 1.59 + /** 1.60 + * Represents an association between an annotation type element 1.61 + * and one of its values. 1.62 + * 1.63 + * @author Scott Seligman 1.64 + * @since 1.5 1.65 + */ 1.66 + public interface ElementValuePair { 1.67 + 1.68 + /** 1.69 + * Returns the annotation type element. 1.70 + * 1.71 + * @return the annotation type element. 1.72 + */ 1.73 + AnnotationTypeElementDoc element(); 1.74 + 1.75 + /** 1.76 + * Returns the value associated with the annotation type element. 1.77 + * 1.78 + * @return the value associated with the annotation type element. 1.79 + */ 1.80 + AnnotationValue value(); 1.81 + } 1.82 +}