src/share/classes/com/sun/mirror/declaration/FieldDeclaration.java

Tue, 16 Sep 2008 18:35:18 -0700

author
jjg
date
Tue, 16 Sep 2008 18:35:18 -0700
changeset 113
eff38cc97183
parent 1
9a66ca7c79fa
child 331
d043adadc8b6
permissions
-rw-r--r--

6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
Reviewed-by: darcy, mcimadamore

duke@1 1 /*
duke@1 2 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package com.sun.mirror.declaration;
duke@1 27
duke@1 28
duke@1 29 import com.sun.mirror.type.TypeMirror;
duke@1 30
duke@1 31
duke@1 32 /**
duke@1 33 * Represents a field of a type declaration.
duke@1 34 *
duke@1 35 * @author Joseph D. Darcy
duke@1 36 * @author Scott Seligman
duke@1 37 * @since 1.5
duke@1 38 */
duke@1 39
duke@1 40 public interface FieldDeclaration extends MemberDeclaration {
duke@1 41
duke@1 42 /**
duke@1 43 * Returns the type of this field.
duke@1 44 *
duke@1 45 * @return the type of this field
duke@1 46 */
duke@1 47 TypeMirror getType();
duke@1 48
duke@1 49 /**
duke@1 50 * Returns the value of this field if this field is a compile-time
duke@1 51 * constant. Returns <tt>null</tt> otherwise.
duke@1 52 * The value will be of a primitive type or <tt>String</tt>.
duke@1 53 * If the value is of a primitive type, it is wrapped in the
duke@1 54 * appropriate wrapper class (such as {@link Integer}).
duke@1 55 *
duke@1 56 * @return the value of this field if this field is a compile-time
duke@1 57 * constant, or <tt>null</tt> otherwise
duke@1 58 */
duke@1 59 Object getConstantValue();
duke@1 60
duke@1 61 /**
duke@1 62 * Returns the text of a <i>constant expression</i> representing the
duke@1 63 * value of this field if this field is a compile-time constant.
duke@1 64 * Returns <tt>null</tt> otherwise.
duke@1 65 * The value will be of a primitive type or <tt>String</tt>.
duke@1 66 * The text returned is in a form suitable for representing the value
duke@1 67 * in source code.
duke@1 68 *
duke@1 69 * @return the text of a constant expression if this field is a
duke@1 70 * compile-time constant, or <tt>null</tt> otherwise
duke@1 71 */
duke@1 72 String getConstantExpression();
duke@1 73 }

mercurial