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 com.sun.mirror.util.SourcePosition;

    29 

    30 /**

    31  * Represents a value of an annotation type element.

    32  *

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

    34  * standardized annotation processing API.  The replacement for the

    35  * functionality of this interface is {@link

    36  * javax.lang.model.element.AnnotationValue}.

    37  *

    38  * @author Joseph D. Darcy

    39  * @author Scott Seligman

    40  * @since 1.5

    41  */

    42 @Deprecated

    43 @SuppressWarnings("deprecation")

    44 public interface AnnotationValue {

    45 

    46     /**

    47      * Returns the value.

    48      * The result has one of the following types:

    49      * <ul><li> a wrapper class (such as {@link Integer}) for a primitive type

    50      *     <li> {@code String}

    51      *     <li> {@code TypeMirror}

    52      *     <li> {@code EnumConstantDeclaration}

    53      *     <li> {@code AnnotationMirror}

    54      *     <li> {@code Collection<AnnotationValue>}

    55      *          (representing the elements, in order, if the value is an array)

    56      * </ul>

    57      *

    58      * @return the value

    59      */

    60     Object getValue();

    61 

    62     /**

    63      * Returns the source position of the beginning of this annotation value.

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

    65      *

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

    67      * and indicates only approximately where an annotation value begins.

    68      *

    69      * @return  the source position of the beginning of this annotation value or

    70      * null if the position is unknown or not applicable

    71      */

    72     SourcePosition getPosition();

    73 

    74     /**

    75      * Returns a string representation of this value.

    76      * This is returned in a form suitable for representing this value

    77      * in the source code of an annotation.

    78      *

    79      * @return a string representation of this value

    80      */

    81     String toString();

    82 }