01: /*
02: * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * 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.type.TypeMirror;
29:
30: /**
31: * Represents a field of a type declaration.
32: *
33: * @author Joseph D. Darcy
34: * @author Scott Seligman
35: * @version 1.9 07/05/05
36: * @since 1.5
37: */
38:
39: public interface FieldDeclaration extends MemberDeclaration {
40:
41: /**
42: * Returns the type of this field.
43: *
44: * @return the type of this field
45: */
46: TypeMirror getType();
47:
48: /**
49: * Returns the value of this field if this field is a compile-time
50: * constant. Returns <tt>null</tt> otherwise.
51: * The value will be of a primitive type or <tt>String</tt>.
52: * If the value is of a primitive type, it is wrapped in the
53: * appropriate wrapper class (such as {@link Integer}).
54: *
55: * @return the value of this field if this field is a compile-time
56: * constant, or <tt>null</tt> otherwise
57: */
58: Object getConstantValue();
59:
60: /**
61: * Returns the text of a <i>constant expression</i> representing the
62: * value of this field if this field is a compile-time constant.
63: * Returns <tt>null</tt> otherwise.
64: * The value will be of a primitive type or <tt>String</tt>.
65: * The text returned is in a form suitable for representing the value
66: * in source code.
67: *
68: * @return the text of a constant expression if this field is a
69: * compile-time constant, or <tt>null</tt> otherwise
70: */
71: String getConstantExpression();
72: }
|