001    /*
002     * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.mirror.declaration;
027    
028    import java.util.Map;
029    import com.sun.mirror.type.AnnotationType;
030    import com.sun.mirror.util.SourcePosition;
031    
032    
033    /**
034     * Represents an annotation.  An annotation associates a value with
035     * each element of an annotation type.
036     *
037     * <p> Annotations should not be compared using reference-equality
038     * ("<tt>==</tt>").  There is no guarantee that any particular
039     * annotation will always be represented by the same object.
040     *
041     * @author Joseph D. Darcy
042     * @author Scott Seligman
043     * @since 1.5
044     */
045    
046    public interface AnnotationMirror {
047    
048        /**
049         * Returns the annotation type of this annotation.
050         *
051         * @return the annotation type of this annotation
052         */
053        AnnotationType getAnnotationType();
054    
055        /**
056         * Returns the source position of the beginning of this annotation.
057         * Returns null if the position is unknown or not applicable.
058         *
059         * <p>This source position is intended for use in providing diagnostics,
060         * and indicates only approximately where an annotation begins.
061         *
062         * @return  the source position of the beginning of this annotation or
063         * null if the position is unknown or not applicable
064         */
065        SourcePosition getPosition();
066    
067        /**
068         * Returns this annotation's elements and their values.
069         * This is returned in the form of a map that associates elements
070         * with their corresponding values.
071         * Only those elements and values explicitly present in the
072         * annotation are included, not those that are implicitly assuming
073         * their default values.
074         * The order of the map matches the order in which the
075         * elements appear in the annotation's source.
076         *
077         * @return this annotation's elements and their values,
078         * or an empty map if there are none
079         */
080        Map<AnnotationTypeElementDeclaration, AnnotationValue> getElementValues();
081    }