FieldDoc (Java SE 11 & JDK 11 ) (original) (raw)
- All Superinterfaces:
[Comparable](../../../../java.base/java/lang/Comparable.html "interface in java.lang")<[Object](../../../../java.base/java/lang/Object.html "class in java.lang")>,[Doc](Doc.html "interface in com.sun.javadoc"),[MemberDoc](MemberDoc.html "interface in com.sun.javadoc"),[ProgramElementDoc](ProgramElementDoc.html "interface in com.sun.javadoc")
@Deprecated(since="9",
forRemoval=true)
public interface FieldDoc
extends MemberDoc
Deprecated, for removal: This API element is subject to removal in a future version.
Represents a field in a java class.
Since:
1.2
See Also:
MemberDoc
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type Method Description Object constantValue() Deprecated, for removal: This API element is subject to removal in a future version. Get the value of a constant field. String constantValueExpression() Deprecated, for removal: This API element is subject to removal in a future version. Get the value of a constant field. boolean isTransient() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this field is transient boolean isVolatile() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this field is volatile SerialFieldTag[] serialFieldTags() Deprecated, for removal: This API element is subject to removal in a future version. Return the serialField tags in this FieldDoc item. Type type() Deprecated, for removal: This API element is subject to removal in a future version. Get type of this field. * ### Methods declared in interface com.sun.javadoc.[Doc](Doc.html "interface in com.sun.javadoc") `[commentText](Doc.html#commentText%28%29), [compareTo](Doc.html#compareTo%28java.lang.Object%29), [firstSentenceTags](Doc.html#firstSentenceTags%28%29), [getRawCommentText](Doc.html#getRawCommentText%28%29), [inlineTags](Doc.html#inlineTags%28%29), [isAnnotationType](Doc.html#isAnnotationType%28%29), [isAnnotationTypeElement](Doc.html#isAnnotationTypeElement%28%29), [isClass](Doc.html#isClass%28%29), [isConstructor](Doc.html#isConstructor%28%29), [isEnum](Doc.html#isEnum%28%29), [isEnumConstant](Doc.html#isEnumConstant%28%29), [isError](Doc.html#isError%28%29), [isException](Doc.html#isException%28%29), [isField](Doc.html#isField%28%29), [isIncluded](Doc.html#isIncluded%28%29), [isInterface](Doc.html#isInterface%28%29), [isMethod](Doc.html#isMethod%28%29), [isOrdinaryClass](Doc.html#isOrdinaryClass%28%29), [name](Doc.html#name%28%29), [position](Doc.html#position%28%29), [seeTags](Doc.html#seeTags%28%29), [setRawCommentText](Doc.html#setRawCommentText%28java.lang.String%29), [tags](Doc.html#tags%28%29), [tags](Doc.html#tags%28java.lang.String%29)` * ### Methods declared in interface com.sun.javadoc.[MemberDoc](MemberDoc.html "interface in com.sun.javadoc") `[isSynthetic](MemberDoc.html#isSynthetic%28%29)` * ### Methods declared in interface com.sun.javadoc.[ProgramElementDoc](ProgramElementDoc.html "interface in com.sun.javadoc") `[annotations](ProgramElementDoc.html#annotations%28%29), [containingClass](ProgramElementDoc.html#containingClass%28%29), [containingPackage](ProgramElementDoc.html#containingPackage%28%29), [isFinal](ProgramElementDoc.html#isFinal%28%29), [isPackagePrivate](ProgramElementDoc.html#isPackagePrivate%28%29), [isPrivate](ProgramElementDoc.html#isPrivate%28%29), [isProtected](ProgramElementDoc.html#isProtected%28%29), [isPublic](ProgramElementDoc.html#isPublic%28%29), [isStatic](ProgramElementDoc.html#isStatic%28%29), [modifiers](ProgramElementDoc.html#modifiers%28%29), [modifierSpecifier](ProgramElementDoc.html#modifierSpecifier%28%29), [qualifiedName](ProgramElementDoc.html#qualifiedName%28%29)`Method Detail
* #### type [Type](Type.html "interface in com.sun.javadoc") type() Deprecated, for removal: This API element is subject to removal in a future version. Get type of this field. Returns: the type of this field. * #### isTransient boolean isTransient() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this field is transient Returns: true if this field is transient * #### isVolatile boolean isVolatile() Deprecated, for removal: This API element is subject to removal in a future version. Return true if this field is volatile Returns: true if this field is volatile * #### serialFieldTags [SerialFieldTag](SerialFieldTag.html "interface in com.sun.javadoc")[] serialFieldTags() Deprecated, for removal: This API element is subject to removal in a future version. Return the serialField tags in this FieldDoc item. Returns: an array of `SerialFieldTag` objects containing all `@serialField` tags. * #### constantValue [Object](../../../../java.base/java/lang/Object.html "class in java.lang") constantValue() Deprecated, for removal: This API element is subject to removal in a future version. Get the value of a constant field. Returns: the value of a constant field. The value is automatically wrapped in an object if it has a primitive type. If the field is not constant, returns null. * #### constantValueExpression [String](../../../../java.base/java/lang/String.html "class in java.lang") constantValueExpression() Deprecated, for removal: This API element is subject to removal in a future version. Get the value of a constant field. Returns: the text of a Java language expression whose value is the value of the constant. The expression uses no identifiers other than primitive literals. If the field is not constant, returns null.
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.