langtools/src/share/classes/com/sun/javadoc/FieldDoc.java
changeset 23136 aa8958a4c8f4
parent 5520 86e4b9a9da40
equal deleted inserted replaced
23135:3c45d467788f 23136:aa8958a4c8f4
     1 /*
     1 /*
     2  * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved.
     2  * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     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
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Oracle designates this
     7  * published by the Free Software Foundation.  Oracle designates this
    35  */
    35  */
    36 public interface FieldDoc extends MemberDoc {
    36 public interface FieldDoc extends MemberDoc {
    37 
    37 
    38     /**
    38     /**
    39      * Get type of this field.
    39      * Get type of this field.
       
    40      *
       
    41      * @return the type of this field.
    40      */
    42      */
    41     Type type();
    43     Type type();
    42 
    44 
    43     /**
    45     /**
    44      * Return true if this field is transient
    46      * Return true if this field is transient
       
    47      *
       
    48      * @return true if this field is transient
    45      */
    49      */
    46     boolean isTransient();
    50     boolean isTransient();
    47 
    51 
    48     /**
    52     /**
    49      * Return true if this field is volatile
    53      * Return true if this field is volatile
       
    54      *
       
    55      * @return true if this field is volatile
    50      */
    56      */
    51     boolean isVolatile();
    57     boolean isVolatile();
    52 
    58 
    53     /**
    59     /**
    54      * Return the serialField tags in this FieldDoc item.
    60      * Return the serialField tags in this FieldDoc item.
    55      *
    61      *
    56      * @return an array of <tt>SerialFieldTag</tt> objects containing
    62      * @return an array of <tt>SerialFieldTag</tt> objects containing
    57      *         all <code>@serialField</code> tags.
    63      *         all {@code @serialField} tags.
    58      */
    64      */
    59     SerialFieldTag[] serialFieldTags();
    65     SerialFieldTag[] serialFieldTags();
    60 
    66 
    61     /**
    67     /**
    62      * Get the value of a constant field.
    68      * Get the value of a constant field.