duke@1: /*
duke@1:  * Copyright 1998-2006 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.javadoc;
duke@1: 
duke@1: /**
duke@1:  * Represents a field in a java class.
duke@1:  *
duke@1:  * @see MemberDoc
duke@1:  *
duke@1:  * @since 1.2
duke@1:  * @author Robert Field
duke@1:  */
duke@1: public interface FieldDoc extends MemberDoc {
duke@1: 
duke@1:     /**
duke@1:      * Get type of this field.
duke@1:      */
duke@1:     Type type();
duke@1: 
duke@1:     /**
duke@1:      * Return true if this field is transient
duke@1:      */
duke@1:     boolean isTransient();
duke@1: 
duke@1:     /**
duke@1:      * Return true if this field is volatile
duke@1:      */
duke@1:     boolean isVolatile();
duke@1: 
duke@1:     /**
duke@1:      * Return the serialField tags in this FieldDoc item.
duke@1:      *
duke@1:      * @return an array of <tt>SerialFieldTag</tt> objects containing
duke@1:      *         all <code>@serialField</code> tags.
duke@1:      */
duke@1:     SerialFieldTag[] serialFieldTags();
duke@1: 
duke@1:     /**
duke@1:      * Get the value of a constant field.
duke@1:      *
duke@1:      * @return the value of a constant field. The value is
duke@1:      * automatically wrapped in an object if it has a primitive type.
duke@1:      * If the field is not constant, returns null.
duke@1:      */
duke@1:     Object constantValue();
duke@1: 
duke@1:     /**
duke@1:      * Get the value of a constant field.
duke@1:      *
duke@1:      * @return the text of a Java language expression whose value
duke@1:      * is the value of the constant. The expression uses no identifiers
duke@1:      * other than primitive literals. If the field is
duke@1:      * not constant, returns null.
duke@1:      */
duke@1:     String constantValueExpression();
duke@1: }