Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/javadoc/FieldDoc.java@2eb010b6cb22 (annotated)
src/share/classes/com/sun/javadoc/FieldDoc.java
Thu, 31 Aug 2017 15:17:03 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:17:03 +0800
- changeset 2525
- 2eb010b6cb22
- parent 554
- 9d9f26857129
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 1998, 2006, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.javadoc; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | /** |
| aoqi@0 | 29 | * Represents a field in a java class. |
| aoqi@0 | 30 | * |
| aoqi@0 | 31 | * @see MemberDoc |
| aoqi@0 | 32 | * |
| aoqi@0 | 33 | * @since 1.2 |
| aoqi@0 | 34 | * @author Robert Field |
| aoqi@0 | 35 | */ |
| aoqi@0 | 36 | public interface FieldDoc extends MemberDoc { |
| aoqi@0 | 37 | |
| aoqi@0 | 38 | /** |
| aoqi@0 | 39 | * Get type of this field. |
| aoqi@0 | 40 | */ |
| aoqi@0 | 41 | Type type(); |
| aoqi@0 | 42 | |
| aoqi@0 | 43 | /** |
| aoqi@0 | 44 | * Return true if this field is transient |
| aoqi@0 | 45 | */ |
| aoqi@0 | 46 | boolean isTransient(); |
| aoqi@0 | 47 | |
| aoqi@0 | 48 | /** |
| aoqi@0 | 49 | * Return true if this field is volatile |
| aoqi@0 | 50 | */ |
| aoqi@0 | 51 | boolean isVolatile(); |
| aoqi@0 | 52 | |
| aoqi@0 | 53 | /** |
| aoqi@0 | 54 | * Return the serialField tags in this FieldDoc item. |
| aoqi@0 | 55 | * |
| aoqi@0 | 56 | * @return an array of <tt>SerialFieldTag</tt> objects containing |
| aoqi@0 | 57 | * all <code>@serialField</code> tags. |
| aoqi@0 | 58 | */ |
| aoqi@0 | 59 | SerialFieldTag[] serialFieldTags(); |
| aoqi@0 | 60 | |
| aoqi@0 | 61 | /** |
| aoqi@0 | 62 | * Get the value of a constant field. |
| aoqi@0 | 63 | * |
| aoqi@0 | 64 | * @return the value of a constant field. The value is |
| aoqi@0 | 65 | * automatically wrapped in an object if it has a primitive type. |
| aoqi@0 | 66 | * If the field is not constant, returns null. |
| aoqi@0 | 67 | */ |
| aoqi@0 | 68 | Object constantValue(); |
| aoqi@0 | 69 | |
| aoqi@0 | 70 | /** |
| aoqi@0 | 71 | * Get the value of a constant field. |
| aoqi@0 | 72 | * |
| aoqi@0 | 73 | * @return the text of a Java language expression whose value |
| aoqi@0 | 74 | * is the value of the constant. The expression uses no identifiers |
| aoqi@0 | 75 | * other than primitive literals. If the field is |
| aoqi@0 | 76 | * not constant, returns null. |
| aoqi@0 | 77 | */ |
| aoqi@0 | 78 | String constantValueExpression(); |
| aoqi@0 | 79 | } |
