Class FieldDocImpl
java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
gw.gosudoc.com.sun.tools.javadoc.main.ProgramElementDocImpl
gw.gosudoc.com.sun.tools.javadoc.main.MemberDocImpl
gw.gosudoc.com.sun.tools.javadoc.main.FieldDocImpl
- All Implemented Interfaces:
Doc
,FieldDoc
,MemberDoc
,ProgramElementDoc
,Comparable<Object>
Deprecated.
Represents a field in a java class.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.2
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Deprecated.private String
Deprecated.protected final com.sun.tools.javac.code.Symbol.VarSymbol
Deprecated.Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.ProgramElementDocImpl
lineMap, tree
Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
documentation, env, treePath
-
Constructor Summary
ConstructorsConstructorDescriptionFieldDocImpl
(DocEnv env, com.sun.tools.javac.code.Symbol.VarSymbol sym) Deprecated.Constructor.FieldDocImpl
(DocEnv env, com.sun.tools.javac.code.Symbol.VarSymbol sym, com.sun.source.util.TreePath treePath) Deprecated.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Get the value of a constant field.Deprecated.Get the value of a constant field.(package private) static String
Deprecated.A static version of the above.protected com.sun.tools.javac.code.Symbol.ClassSymbol
Deprecated.Identify the containing classprotected long
getFlags()
Deprecated.Returns the flags in terms of javac's flagsboolean
Deprecated.Is this Doc item an enum constant? (For legacy doclets, return false.)boolean
isField()
Deprecated.Is this Doc item a field (but not an enum constant?boolean
Deprecated.Return true if this field is included in the active set.private static boolean
isPrintableAscii
(char c) Deprecated.boolean
Deprecated.Returns true if this field was synthesized by the compiler.boolean
Deprecated.Return true if this field is transientboolean
Deprecated.Return true if this field is volatilename()
Deprecated.Returns the name of this Doc item.position()
Deprecated.Return the source position of the entity, or null if no position is available.Deprecated.Returns the qualified name of this Doc item.Deprecated.Return the serialField tags in this FieldDocImpl item.private static void
sourceChar
(char c, StringBuilder buf) Deprecated.private static String
sourceForm
(byte c) Deprecated.private static String
sourceForm
(char c) Deprecated.private static String
sourceForm
(double v, char suffix) Deprecated.private static String
sourceForm
(String s) Deprecated.type()
Deprecated.Get type of this field.private static void
unicodeEscape
(char c, StringBuilder buf) Deprecated.Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.ProgramElementDocImpl
annotations, containingClass, containingPackage, generateKey, getModifiers, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, setTreePath
Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
comment, commentText, compareTo, documentation, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isError, isException, isInterface, isMethod, isOrdinaryClass, key, readHTMLDocumentation, seeTags, setRawCommentText, tags, tags, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface gw.gosudoc.com.sun.javadoc.Doc
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isError, isException, isInterface, isMethod, isOrdinaryClass, seeTags, setRawCommentText, tags, tags
Methods inherited from interface gw.gosudoc.com.sun.javadoc.ProgramElementDoc
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier
-
Field Details
-
sym
protected final com.sun.tools.javac.code.Symbol.VarSymbol symDeprecated. -
name
Deprecated. -
qualifiedName
Deprecated.
-
-
Constructor Details
-
FieldDocImpl
public FieldDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.VarSymbol sym, com.sun.source.util.TreePath treePath) Deprecated.Constructor. -
FieldDocImpl
Deprecated.Constructor.
-
-
Method Details
-
getFlags
protected long getFlags()Deprecated.Returns the flags in terms of javac's flags- Specified by:
getFlags
in classProgramElementDocImpl
-
getContainingClass
protected com.sun.tools.javac.code.Symbol.ClassSymbol getContainingClass()Deprecated.Identify the containing class- Specified by:
getContainingClass
in classProgramElementDocImpl
-
type
Deprecated.Get type of this field. -
constantValue
Deprecated.Get the value of a constant field.- Specified by:
constantValue
in interfaceFieldDoc
- 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
Deprecated.Get the value of a constant field.- Specified by:
constantValueExpression
in interfaceFieldDoc
- 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.
-
constantValueExpression
Deprecated.A static version of the above. -
sourceForm
Deprecated. -
sourceForm
Deprecated. -
sourceForm
Deprecated. -
sourceForm
Deprecated. -
sourceChar
Deprecated. -
unicodeEscape
Deprecated. -
isPrintableAscii
private static boolean isPrintableAscii(char c) Deprecated. -
isIncluded
public boolean isIncluded()Deprecated.Return true if this field is included in the active set.- Specified by:
isIncluded
in interfaceDoc
- Specified by:
isIncluded
in classDocImpl
- Returns:
- true if this Doc item is included in the result set.
-
isField
public boolean isField()Deprecated.Is this Doc item a field (but not an enum constant? -
isEnumConstant
public boolean isEnumConstant()Deprecated.Is this Doc item an enum constant? (For legacy doclets, return false.)- Specified by:
isEnumConstant
in interfaceDoc
- Overrides:
isEnumConstant
in classDocImpl
- Returns:
- true if it represents an enum constant
-
isTransient
public boolean isTransient()Deprecated.Return true if this field is transient- Specified by:
isTransient
in interfaceFieldDoc
- Returns:
- true if this field is transient
-
isVolatile
public boolean isVolatile()Deprecated.Return true if this field is volatile- Specified by:
isVolatile
in interfaceFieldDoc
- Returns:
- true if this field is volatile
-
isSynthetic
public boolean isSynthetic()Deprecated.Returns true if this field was synthesized by the compiler.- Specified by:
isSynthetic
in interfaceMemberDoc
- Specified by:
isSynthetic
in classMemberDocImpl
- Returns:
- true if this member was synthesized by the compiler.
-
serialFieldTags
Deprecated.Return the serialField tags in this FieldDocImpl item.- Specified by:
serialFieldTags
in interfaceFieldDoc
- Returns:
- an array of SerialFieldTagImpl containing all
@serialField
tags.
-
name
Deprecated.Description copied from class:DocImpl
Returns the name of this Doc item. -
qualifiedName
Deprecated.Description copied from class:DocImpl
Returns the qualified name of this Doc item.- Specified by:
qualifiedName
in interfaceProgramElementDoc
- Specified by:
qualifiedName
in classDocImpl
- Returns:
- the name
-
position
Deprecated.Return the source position of the entity, or null if no position is available.
-