com.sun.javadoc
Interface FieldDoc


public abstract interface FieldDoc
extends MemberDoc

Represents a field in a java class.

Since:
JDK1.2
See Also:
MemberDoc

Fields inherited from class java.io.Serializable
serialVersionUID
 
Method Summary
 boolean isTransient()
          Return true if this field is transient
 boolean isVolatile()
          Return true if this field is volatile
 SerialFieldTag[] serialFieldTags()
          Return the serialField tags in this FieldDoc item.
 Type type()
          Get type of this field.
 
Methods inherited from interface com.sun.javadoc.MemberDoc
isSynthetic
 
Methods inherited from interface com.sun.javadoc.ProgramElementDoc
containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
 
Methods inherited from interface com.sun.javadoc.Doc
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags
 

Method Detail

type

public Type type()
Get type of this field.

isTransient

public boolean isTransient()
Return true if this field is transient

isVolatile

public boolean isVolatile()
Return true if this field is volatile

serialFieldTags

public SerialFieldTag[] serialFieldTags()
Return the serialField tags in this FieldDoc item.
Returns:
an array of SerialFieldTag<\tt> containing all @serialField<\code> tags.