1 /*

     2  * Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package com.sun.javadoc;

    27 

    28 /**

    29  * Represents a field in a java class.

    30  *

    31  * @see MemberDoc

    32  *

    33  * @since 1.2

    34  * @author Robert Field

    35  *

    36  * @deprecated

    37  *   The declarations in this package have been superseded by those

    38  *   in the package {@code jdk.javadoc.doclet}.

    39  *   For more information, see the <i>Migration Guide</i> in the documentation for that package.

    40  */

    41 @Deprecated(since="9", forRemoval=true)

    42 @SuppressWarnings("removal")

    43 public interface FieldDoc extends MemberDoc {

    44 

    45     /**

    46      * Get type of this field.

    47      *

    48      * @return the type of this field.

    49      */

    50     Type type();

    51 

    52     /**

    53      * Return true if this field is transient

    54      *

    55      * @return true if this field is transient

    56      */

    57     boolean isTransient();

    58 

    59     /**

    60      * Return true if this field is volatile

    61      *

    62      * @return true if this field is volatile

    63      */

    64     boolean isVolatile();

    65 

    66     /**

    67      * Return the serialField tags in this FieldDoc item.

    68      *

    69      * @return an array of {@code SerialFieldTag} objects containing

    70      *         all {@code @serialField} tags.

    71      */

    72     SerialFieldTag[] serialFieldTags();

    73 

    74     /**

    75      * Get the value of a constant field.

    76      *

    77      * @return the value of a constant field. The value is

    78      * automatically wrapped in an object if it has a primitive type.

    79      * If the field is not constant, returns null.

    80      */

    81     Object constantValue();

    82 

    83     /**

    84      * Get the value of a constant field.

    85      *

    86      * @return the text of a Java language expression whose value

    87      * is the value of the constant. The expression uses no identifiers

    88      * other than primitive literals. If the field is

    89      * not constant, returns null.

    90      */

    91     String constantValueExpression();

    92 }