Interface FieldDoc
- All Superinterfaces:
-
Comparable<Object>,Doc,MemberDoc,ProgramElementDoc
@Deprecated(since="9",
forRemoval=true)
public interface FieldDoc
extends MemberDoc jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.Represents a field in a java class.
- Since:
- 1.2
- See Also:
MemberDoc
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
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags Methods declared in interface com.sun.javadoc.MemberDoc
isSynthetic Methods declared in interface com.sun.javadoc.ProgramElementDoc
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName Methods
type
Type type()
Get type of this field.
- Returns:
- the type of this field.
isTransient
boolean isTransient()
Return true if this field is transient
- Returns:
- true if this field is transient
isVolatile
boolean isVolatile()
Return true if this field is volatile
- Returns:
- true if this field is volatile
serialFieldTags
SerialFieldTag[] serialFieldTags()
Return the serialField tags in this FieldDoc item.
- Returns:
- an array of
SerialFieldTagobjects containing all@serialFieldtags.
constantValue
Object constantValue()
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 constantValueExpression()
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.
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.javadoc/com/sun/javadoc/FieldDoc.html