1 /*

     2  * Copyright (c) 2004, 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.mirror.declaration;

    27 

    28 import java.util.Map;

    29 import com.sun.mirror.type.AnnotationType;

    30 import com.sun.mirror.util.SourcePosition;

    31 

    32 

    33 /**

    34  * Represents an annotation.  An annotation associates a value with

    35  * each element of an annotation type.

    36  *

    37  * <p> Annotations should not be compared using reference-equality

    38  * ("<tt>==</tt>").  There is no guarantee that any particular

    39  * annotation will always be represented by the same object.

    40  *

    41  * @deprecated All components of this API have been superseded by the

    42  * standardized annotation processing API.  The replacement for the

    43  * functionality of this interface is {@link

    44  * javax.lang.model.element.AnnotationMirror}.

    45  *

    46  * @author Joseph D. Darcy

    47  * @author Scott Seligman

    48  * @since 1.5

    49  */

    50 @Deprecated

    51 @SuppressWarnings("deprecation")

    52 public interface AnnotationMirror {

    53 

    54     /**

    55      * Returns the annotation type of this annotation.

    56      *

    57      * @return the annotation type of this annotation

    58      */

    59     AnnotationType getAnnotationType();

    60 

    61     /**

    62      * Returns the source position of the beginning of this annotation.

    63      * Returns null if the position is unknown or not applicable.

    64      *

    65      * <p>This source position is intended for use in providing diagnostics,

    66      * and indicates only approximately where an annotation begins.

    67      *

    68      * @return  the source position of the beginning of this annotation or

    69      * null if the position is unknown or not applicable

    70      */

    71     SourcePosition getPosition();

    72 

    73     /**

    74      * Returns this annotation's elements and their values.

    75      * This is returned in the form of a map that associates elements

    76      * with their corresponding values.

    77      * Only those elements and values explicitly present in the

    78      * annotation are included, not those that are implicitly assuming

    79      * their default values.

    80      * The order of the map matches the order in which the

    81      * elements appear in the annotation's source.

    82      *

    83      * @return this annotation's elements and their values,

    84      * or an empty map if there are none

    85      */

    86     Map<AnnotationTypeElementDeclaration, AnnotationValue> getElementValues();

    87 }