1 /*
   2  * Copyright 2004 Sun Microsystems, Inc.  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.  Sun designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  22  * CA 95054 USA or visit www.sun.com if you need additional information or
  23  * have any 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  * @author Joseph D. Darcy
  34  * @author Scott Seligman
  35  * @since 1.5
  36  */
  37 
  38 public interface AnnotationValue {
  39 
  40     /**
  41      * Returns the value.
  42      * The result has one of the following types:
  43      * <ul><li> a wrapper class (such as {@link Integer}) for a primitive type
  44      *     <li> {@code String}
  45      *     <li> {@code TypeMirror}
  46      *     <li> {@code EnumConstantDeclaration}
  47      *     <li> {@code AnnotationMirror}
  48      *     <li> {@code Collection<AnnotationValue>}
  49      *          (representing the elements, in order, if the value is an array)
  50      * </ul>
  51      *
  52      * @return the value
  53      */
  54     Object getValue();
  55 
  56     /**
  57      * Returns the source position of the beginning of this annotation value.
  58      * Returns null if the position is unknown or not applicable.
  59      *
  60      * <p>This source position is intended for use in providing diagnostics,
  61      * and indicates only approximately where an annotation value begins.
  62      *
  63      * @return  the source position of the beginning of this annotation value or
  64      * null if the position is unknown or not applicable
  65      */
  66     SourcePosition getPosition();
  67 
  68     /**
  69      * Returns a string representation of this value.
  70      * This is returned in a form suitable for representing this value
  71      * in the source code of an annotation.
  72      *
  73      * @return a string representation of this value
  74      */
  75     String toString();
  76 }