1 /* 2 * Copyright (c) 2003, 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.javadoc; 27 28 29 import com.google.doclava.annotation.Unused; 30 import com.google.doclava.annotation.Used; 31 32 /** 33 * Represents a value of an annotation type element. 34 * 35 * @author Scott Seligman 36 * @since 1.5 37 */ 38 public interface AnnotationValue { 39 40 /** 41 * Returns the value. 42 * The type of the returned object is one of the following: 43 * <ul><li> a wrapper class for a primitive type 44 * <li> <code>String</code> 45 * <li> <code>Type</code> (representing a class literal) 46 * <li> <code>FieldDoc</code> (representing an enum constant) 47 * <li> <code>AnnotationDesc</code> 48 * <li> <code>AnnotationValue[]</code> 49 * </ul> 50 * 51 * @return the value. 52 */ 53 @Used value()54 Object value(); 55 56 /** 57 * Returns a string representation of the value. 58 * 59 * @return the text of a Java language annotation value expression 60 * whose value is the value of this element. 61 */ 62 @Unused toString()63 String toString(); 64 } 65