duke@1: /*
ohair@554:  * Copyright (c) 2003, 2004, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.javadoc;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * Represents an annotation.
duke@1:  * An annotation associates a value with each element of an annotation type.
duke@1:  *
duke@1:  * @author Scott Seligman
duke@1:  * @since 1.5
duke@1:  */
duke@1: public interface AnnotationDesc {
duke@1: 
duke@1:     /**
duke@1:      * Returns the annotation type of this annotation.
duke@1:      *
duke@1:      * @return the annotation type of this annotation.
duke@1:      */
duke@1:     AnnotationTypeDoc annotationType();
duke@1: 
duke@1:     /**
duke@1:      * Returns this annotation's elements and their values.
duke@1:      * Only those explicitly present in the annotation are
duke@1:      * included, not those assuming their default values.
duke@1:      * Returns an empty array if there are none.
duke@1:      *
duke@1:      * @return this annotation's elements and their values.
duke@1:      */
duke@1:     ElementValuePair[] elementValues();
duke@1: 
bpatel@1477:     /**
bpatel@1477:      * Check for the synthesized bit on the annotation.
bpatel@1477:      *
bpatel@1477:      * @return true if the annotation is synthesized.
bpatel@1477:      */
bpatel@1477:     boolean isSynthesized();
duke@1: 
duke@1:     /**
duke@1:      * Represents an association between an annotation type element
duke@1:      * and one of its values.
duke@1:      *
duke@1:      * @author Scott Seligman
duke@1:      * @since 1.5
duke@1:      */
duke@1:     public interface ElementValuePair {
duke@1: 
duke@1:         /**
duke@1:          * Returns the annotation type element.
duke@1:          *
duke@1:          * @return the annotation type element.
duke@1:          */
duke@1:         AnnotationTypeElementDoc element();
duke@1: 
duke@1:         /**
duke@1:          * Returns the value associated with the annotation type element.
duke@1:          *
duke@1:          * @return the value associated with the annotation type element.
duke@1:          */
duke@1:         AnnotationValue value();
duke@1:     }
duke@1: }