Package gw.gosudoc.com.sun.tools.javadoc.main

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
public class FieldDocImpl
extends MemberDocImpl
implements FieldDoc

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

Author:

Robert Field, Neal Gafter (rewrite), Scott Seligman (generics, enums, annotations)

See Also:

MemberDocImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected com.sun.tools.javac.code.Symbol.VarSymbol	sym	Deprecated.

Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

documentation, env, treePath

Constructor Summary

Constructors

Constructor	Description
FieldDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.VarSymbol sym)	Deprecated. Constructor.
FieldDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.VarSymbol sym, TreePath treePath)	Deprecated. Constructor.

Method Summary

Modifier and Type	Method	Description
Object	constantValue()	Deprecated. Get the value of a constant field.
String	constantValueExpression()	Deprecated. Get the value of a constant field.
protected com.sun.tools.javac.code.Symbol.ClassSymbol	getContainingClass()	Deprecated. Identify the containing class
protected long	getFlags()	Deprecated. Returns the flags in terms of javac's flags
boolean	isEnumConstant()	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	isIncluded()	Deprecated. Return true if this field is included in the active set.
boolean	isSynthetic()	Deprecated. Returns true if this field was synthesized by the compiler.
boolean	isTransient()	Deprecated. Return true if this field is transient
boolean	isVolatile()	Deprecated. Return true if this field is volatile
String	name()	Deprecated. Returns the name of this Doc item.
SourcePosition	position()	Deprecated. Return the source position of the entity, or null if no position is available.
String	qualifiedName()	Deprecated. Returns the qualified name of this Doc item.
SerialFieldTag[]	serialFieldTags()	Deprecated. Return the serialField tags in this FieldDocImpl item.
Type	type()	Deprecated. Get type of this field.

Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.ProgramElementDocImpl

annotations, containingClass, containingPackage, getModifiers, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier

Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl

commentText, compareTo, documentation, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isError, isException, isInterface, isMethod, isOrdinaryClass, 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 Detail

sym

protected final com.sun.tools.javac.code.Symbol.VarSymbol sym

Deprecated.

Constructor Detail

FieldDocImpl

public FieldDocImpl(DocEnv env,
                    com.sun.tools.javac.code.Symbol.VarSymbol sym,
                    TreePath treePath)

Deprecated.

Constructor.

FieldDocImpl

public FieldDocImpl(DocEnv env,
                    com.sun.tools.javac.code.Symbol.VarSymbol sym)

Deprecated.

Constructor.

Method Detail

getFlags

protected long getFlags()

Deprecated.

Returns the flags in terms of javac's flags

Specified by:

getFlags in class ProgramElementDocImpl

getContainingClass

protected com.sun.tools.javac.code.Symbol.ClassSymbol getContainingClass()

Deprecated.

Identify the containing class

Specified by:

getContainingClass in class ProgramElementDocImpl

type

public Type type()

Deprecated.

Get type of this field.

Specified by:

type in interface FieldDoc

Returns:

the type of this field.

constantValue

public Object constantValue()

Deprecated.

Get the value of a constant field.

Specified by:

constantValue in interface FieldDoc

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

public String constantValueExpression()

Deprecated.

Get the value of a constant field.

Specified by:

constantValueExpression in interface FieldDoc

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.

isIncluded

public boolean isIncluded()

Deprecated.

Return true if this field is included in the active set.

Specified by:

isIncluded in interface Doc

Specified by:

isIncluded in class DocImpl

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?

Specified by:

isField in interface Doc

Overrides:

isField in class DocImpl

Returns:

true if it represents a field

isEnumConstant

public boolean isEnumConstant()

Deprecated.

Is this Doc item an enum constant? (For legacy doclets, return false.)

Specified by:

isEnumConstant in interface Doc

Overrides:

isEnumConstant in class DocImpl

Returns:

true if it represents an enum constant

isTransient

public boolean isTransient()

Deprecated.

Return true if this field is transient

Specified by:

isTransient in interface FieldDoc

Returns:

true if this field is transient

isVolatile

public boolean isVolatile()

Deprecated.

Return true if this field is volatile

Specified by:

isVolatile in interface FieldDoc

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 interface MemberDoc

Specified by:

isSynthetic in class MemberDocImpl

Returns:

true if this member was synthesized by the compiler.

serialFieldTags

public SerialFieldTag[] serialFieldTags()

Deprecated.

Return the serialField tags in this FieldDocImpl item.

Specified by:

serialFieldTags in interface FieldDoc

Returns:

an array of SerialFieldTagImpl containing all @serialField tags.

name

public String name()

Deprecated.

Description copied from class: DocImpl

Returns the name of this Doc item.

Specified by:

name in interface Doc

Specified by:

name in class DocImpl

Returns:

the name

qualifiedName

public String qualifiedName()

Deprecated.

Description copied from class: DocImpl

Returns the qualified name of this Doc item.

Specified by:

qualifiedName in interface ProgramElementDoc

Specified by:

qualifiedName in class DocImpl

Returns:

the name

position

public SourcePosition position()

Deprecated.

Return the source position of the entity, or null if no position is available.

Specified by:

position in interface Doc

Overrides:

position in class DocImpl

Returns:

the source positino of the first line of the corresponding declaration, or null if no position is available. A default constructor returns null because it has no location in the source file.