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