/*
 * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.javadoc;

Represents a field in a java class.
Author:Robert Field
See Also:
  • MemberDoc
Since:1.2
Deprecated: The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
/** * Represents a field in a java class. * * @see MemberDoc * * @since 1.2 * @author Robert Field * * @deprecated * The declarations in this package have been superseded by those * in the package {@code jdk.javadoc.doclet}. * For more information, see the <i>Migration Guide</i> in the documentation for that package. */
@Deprecated public interface FieldDoc extends MemberDoc {
Get type of this field.
Returns:the type of this field.
/** * Get type of this field. * * @return the type of this field. */
Type type();
Return true if this field is transient
Returns:true if this field is transient
/** * Return true if this field is transient * * @return true if this field is transient */
boolean isTransient();
Return true if this field is volatile
Returns:true if this field is volatile
/** * Return true if this field is volatile * * @return true if this field is volatile */
boolean isVolatile();
Return the serialField tags in this FieldDoc item.
Returns:an array of SerialFieldTag objects containing all @serialField tags.
/** * Return the serialField tags in this FieldDoc item. * * @return an array of {@code SerialFieldTag} objects containing * all {@code @serialField} tags. */
SerialFieldTag[] serialFieldTags();
Get the value of a constant field.
Returns:the value of a constant field. The value is automatically wrapped in an object if it has a primitive type. If the field is not constant, returns null.
/** * Get the value of a constant field. * * @return the value of a constant field. The value is * automatically wrapped in an object if it has a primitive type. * If the field is not constant, returns null. */
Object constantValue();
Get the value of a constant field.
Returns:the text of a Java language expression whose value is the value of the constant. The expression uses no identifiers other than primitive literals. If the field is not constant, returns null.
/** * Get the value of a constant field. * * @return the text of a Java language expression whose value * is the value of the constant. The expression uses no identifiers * other than primitive literals. If the field is * not constant, returns null. */
String constantValueExpression(); }