jdk8-mips64-public/langtools: src/share/classes/com/sun/javadoc/FieldDoc.java@998b10c43157

8029230: Update copyright year to match last edit in jdk8 langtools repository for 2013
Reviewed-by: ksrini
Contributed-by: steve.sides@oracle.com

     1 /*

     2  * Copyright (c) 1998, 2006, 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  */

    26 package com.sun.javadoc;

    28 /**

    29  * Represents a field in a java class.

    30  *

    31  * @see MemberDoc

    32  *

    33  * @since 1.2

    34  * @author Robert Field

    35  */

    36 public interface FieldDoc extends MemberDoc {

    38     /**

    39      * Get type of this field.

    40      */

    41     Type type();

    43     /**

    44      * Return true if this field is transient

    45      */

    46     boolean isTransient();

    48     /**

    49      * Return true if this field is volatile

    50      */

    51     boolean isVolatile();

    53     /**

    54      * Return the serialField tags in this FieldDoc item.

    55      *

    56      * @return an array of <tt>SerialFieldTag</tt> objects containing

    57      *         all <code>@serialField</code> tags.

    58      */

    59     SerialFieldTag[] serialFieldTags();

    61     /**

    62      * Get the value of a constant field.

    63      *

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

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

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

    67      */

    68     Object constantValue();

    70     /**

    71      * Get the value of a constant field.

    72      *

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

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

    75      * other than primitive literals. If the field is

    76      * not constant, returns null.

    77      */

    78     String constantValueExpression();

    79 }

Mercurial > jdk8-mips64-public > langtools / file revision