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