01: /*
02: * @(#)AnnotationValue.java 1.6 04/07/19
03: *
04: * Copyright (c) 2004, Sun Microsystems, Inc.
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions are met:
09: *
10: * * Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * * Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in the
14: * documentation and/or other materials provided with the distribution.
15: * * Neither the name of the Sun Microsystems, Inc. nor the names of
16: * its contributors may be used to endorse or promote products derived from
17: * this software without specific prior written permission.
18: *
19: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
20: * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21: * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
23: * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30: */
31:
32: package com.sun.mirror.declaration;
33:
34: import com.sun.mirror.util.SourcePosition;
35:
36: /**
37: * Represents a value of an annotation type element.
38: *
39: * @author Joseph D. Darcy
40: * @author Scott Seligman
41: * @version 1.6 04/07/19
42: * @since 1.5
43: */
44:
45: public interface AnnotationValue {
46:
47: /**
48: * Returns the value.
49: * The result has one of the following types:
50: * <ul><li> a wrapper class (such as {@link Integer}) for a primitive type
51: * <li> {@code String}
52: * <li> {@code TypeMirror}
53: * <li> {@code EnumConstantDeclaration}
54: * <li> {@code AnnotationMirror}
55: * <li> {@code Collection<AnnotationValue>}
56: * (representing the elements, in order, if the value is an array)
57: * </ul>
58: *
59: * @return the value
60: */
61: Object getValue();
62:
63: /**
64: * Returns the source position of the beginning of this annotation value.
65: * Returns null if the position is unknown or not applicable.
66: *
67: * <p>This source position is intended for use in providing diagnostics,
68: * and indicates only approximately where an annotation value begins.
69: *
70: * @return the source position of the beginning of this annotation value or
71: * null if the position is unknown or not applicable
72: */
73: SourcePosition getPosition();
74:
75: /**
76: * Returns a string representation of this value.
77: * This is returned in a form suitable for representing this value
78: * in the source code of an annotation.
79: *
80: * @return a string representation of this value
81: */
82: String toString();
83: }
|