01: /*
02: * @(#)FieldDeclaration.java 1.2 04/04/20
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.type.TypeMirror;
35:
36: /**
37: * Represents a field of a type declaration.
38: *
39: * @author Joseph D. Darcy
40: * @author Scott Seligman
41: * @version 1.2 04/04/20
42: * @since 1.5
43: */
44:
45: public interface FieldDeclaration extends MemberDeclaration {
46:
47: /**
48: * Returns the type of this field.
49: *
50: * @return the type of this field
51: */
52: TypeMirror getType();
53:
54: /**
55: * Returns the value of this field if this field is a compile-time
56: * constant. Returns <tt>null</tt> otherwise.
57: * The value will be of a primitive type or <tt>String</tt>.
58: * If the value is of a primitive type, it is wrapped in the
59: * appropriate wrapper class (such as {@link Integer}).
60: *
61: * @return the value of this field if this field is a compile-time
62: * constant, or <tt>null</tt> otherwise
63: */
64: Object getConstantValue();
65:
66: /**
67: * Returns the text of a <i>constant expression</i> representing the
68: * value of this field if this field is a compile-time constant.
69: * Returns <tt>null</tt> otherwise.
70: * The value will be of a primitive type or <tt>String</tt>.
71: * The text returned is in a form suitable for representing the value
72: * in source code.
73: *
74: * @return the text of a constant expression if this field is a
75: * compile-time constant, or <tt>null</tt> otherwise
76: */
77: String getConstantExpression();
78: }
|