duke@1: /*
ohair@554:  * Copyright (c) 2005, 2006, 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 javax.lang.model.element;
duke@1: 
duke@1: import java.util.Map;
duke@1: import javax.lang.model.type.DeclaredType;
duke@1: 
duke@1: /**
duke@1:  * Represents an annotation.  An annotation associates a value with
duke@1:  * each element of an annotation type.
duke@1:  *
duke@1:  * <p> Annotations should be compared using the {@code equals}
duke@1:  * method.  There is no guarantee that any particular annotation will
duke@1:  * always be represented by the same object.
duke@1:  *
duke@1:  * @author Joseph D. Darcy
duke@1:  * @author Scott Seligman
duke@1:  * @author Peter von der Ah&eacute;
duke@1:  * @since 1.6
duke@1:  */
duke@1: public interface AnnotationMirror {
duke@1: 
duke@1:     /**
duke@1:      * Returns the type of this annotation.
duke@1:      *
duke@1:      * @return the type of this annotation
duke@1:      */
duke@1:     DeclaredType getAnnotationType();
duke@1: 
duke@1:     /**
duke@1:      * Returns the values of this annotation's elements.
duke@1:      * This is returned in the form of a map that associates elements
duke@1:      * with their corresponding values.
duke@1:      * Only those elements with values explicitly present in the
duke@1:      * annotation are included, not those that are implicitly assuming
duke@1:      * their default values.
duke@1:      * The order of the map matches the order in which the
duke@1:      * values appear in the annotation's source.
duke@1:      *
duke@1:      * <p>Note that an annotation mirror of a marker annotation type
duke@1:      * will by definition have an empty map.
duke@1:      *
duke@1:      * <p>To fill in default values, use {@link
duke@1:      * javax.lang.model.util.Elements#getElementValuesWithDefaults
duke@1:      * getElementValuesWithDefaults}.
duke@1:      *
duke@1:      * @return the values of this annotation's elements,
duke@1:      *          or an empty map if there are none
duke@1:      */
duke@1:     Map<? extends ExecutableElement, ? extends AnnotationValue> getElementValues();
duke@1: }