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 */ 25 26 package com.sun.javadoc; 27 28 29 import com.google.doclava.annotation.Unused; 30 import com.google.doclava.annotation.Used; 31 32 /** 33 * Represents an annotation. 34 * An annotation associates a value with each element of an annotation type. 35 * 36 * @author Scott Seligman 37 * @since 1.5 38 */ 39 public interface AnnotationDesc { 40 41 /** 42 * Returns the annotation type of this annotation. 43 * 44 * @return the annotation type of this annotation. 45 */ 46 @Used annotationType()47 AnnotationTypeDoc annotationType(); 48 49 /** 50 * Returns this annotation's elements and their values. 51 * Only those explicitly present in the annotation are 52 * included, not those assuming their default values. 53 * Returns an empty array if there are none. 54 * 55 * @return this annotation's elements and their values. 56 */ 57 @Used elementValues()58 ElementValuePair[] elementValues(); 59 60 /** 61 * Check for the synthesized bit on the annotation. 62 * 63 * @return true if the annotation is synthesized. 64 */ 65 @Unused isSynthesized()66 boolean isSynthesized(); 67 68 /** 69 * Represents an association between an annotation type element 70 * and one of its values. 71 * 72 * @author Scott Seligman 73 * @since 1.5 74 */ 75 interface ElementValuePair { 76 77 /** 78 * Returns the annotation type element. 79 * 80 * @return the annotation type element. 81 */ 82 @Used element()83 AnnotationTypeElementDoc element(); 84 85 /** 86 * Returns the value associated with the annotation type element. 87 * 88 * @return the value associated with the annotation type element. 89 */ 90 @Used value()91 AnnotationValue value(); 92 } 93 } 94