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