001    /*
002     * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.mirror.declaration;
027    
028    
029    import com.sun.mirror.type.TypeMirror;
030    
031    
032    /**
033     * Represents a field of a type declaration.
034     *
035     * @author Joseph D. Darcy
036     * @author Scott Seligman
037     * @since 1.5
038     */
039    
040    public interface FieldDeclaration extends MemberDeclaration {
041    
042        /**
043         * Returns the type of this field.
044         *
045         * @return the type of this field
046         */
047        TypeMirror getType();
048    
049        /**
050         * Returns the value of this field if this field is a compile-time
051         * constant.  Returns <tt>null</tt> otherwise.
052         * The value will be of a primitive type or <tt>String</tt>.
053         * If the value is of a primitive type, it is wrapped in the
054         * appropriate wrapper class (such as {@link Integer}).
055         *
056         * @return the value of this field if this field is a compile-time
057         * constant, or <tt>null</tt> otherwise
058         */
059        Object getConstantValue();
060    
061        /**
062         * Returns the text of a <i>constant expression</i> representing the
063         * value of this field if this field is a compile-time constant.
064         * Returns <tt>null</tt> otherwise.
065         * The value will be of a primitive type or <tt>String</tt>.
066         * The text returned is in a form suitable for representing the value
067         * in source code.
068         *
069         * @return the text of a constant expression if this field is a
070         *          compile-time constant, or <tt>null</tt> otherwise
071         */
072        String getConstantExpression();
073    }