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

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/javadoc/FieldDoc.java	Wed Apr 27 01:34:52 2016 +0800
     1.3 @@ -0,0 +1,79 @@
     1.4 +/*
     1.5 + * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.javadoc;
    1.30 +
    1.31 +/**
    1.32 + * Represents a field in a java class.
    1.33 + *
    1.34 + * @see MemberDoc
    1.35 + *
    1.36 + * @since 1.2
    1.37 + * @author Robert Field
    1.38 + */
    1.39 +public interface FieldDoc extends MemberDoc {
    1.40 +
    1.41 +    /**
    1.42 +     * Get type of this field.
    1.43 +     */
    1.44 +    Type type();
    1.45 +
    1.46 +    /**
    1.47 +     * Return true if this field is transient
    1.48 +     */
    1.49 +    boolean isTransient();
    1.50 +
    1.51 +    /**
    1.52 +     * Return true if this field is volatile
    1.53 +     */
    1.54 +    boolean isVolatile();
    1.55 +
    1.56 +    /**
    1.57 +     * Return the serialField tags in this FieldDoc item.
    1.58 +     *
    1.59 +     * @return an array of <tt>SerialFieldTag</tt> objects containing
    1.60 +     *         all <code>@serialField</code> tags.
    1.61 +     */
    1.62 +    SerialFieldTag[] serialFieldTags();
    1.63 +
    1.64 +    /**
    1.65 +     * Get the value of a constant field.
    1.66 +     *
    1.67 +     * @return the value of a constant field. The value is
    1.68 +     * automatically wrapped in an object if it has a primitive type.
    1.69 +     * If the field is not constant, returns null.
    1.70 +     */
    1.71 +    Object constantValue();
    1.72 +
    1.73 +    /**
    1.74 +     * Get the value of a constant field.
    1.75 +     *
    1.76 +     * @return the text of a Java language expression whose value
    1.77 +     * is the value of the constant. The expression uses no identifiers
    1.78 +     * other than primitive literals. If the field is
    1.79 +     * not constant, returns null.
    1.80 +     */
    1.81 +    String constantValueExpression();
    1.82 +}