com.go.beandoc.teadoc
Class PropertyDoc

java.lang.Object
  |
  +--com.go.beandoc.teadoc.Doc
        |
        +--com.go.beandoc.teadoc.ProgramElementDoc
              |
              +--com.go.beandoc.teadoc.MemberDoc
                    |
                    +--com.go.beandoc.teadoc.PropertyDoc
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable

public class PropertyDoc
extends MemberDoc

There is no Doclet equivalent for this class. It was created from scratch to make documenting JavaBean properties easier.

Version:
7 , 8/23/00
Author:
Mark Masse
See Also:
Serialized Form

Inner classes inherited from class com.go.beandoc.teadoc.Doc
Doc.TagMap
 
Fields inherited from class com.go.beandoc.teadoc.Doc
mRootDoc
 
Constructor Summary
PropertyDoc(RootDoc root, MethodDoc methodDoc, boolean isReadMethod)
           
 
Method Summary
static PropertyDoc[] create(RootDoc root, MethodDoc[] docs)
          Creates a set of PropertyDoc objects from the specified MemberDocs.
 java.lang.String getCommentText()
           
 java.lang.String getName()
           
 java.lang.String getPropertyEditorClassName()
           
 MethodDoc getReadMethod()
           
 java.lang.String getTagValue(java.lang.String tagName)
          Gets the text value of the first tag in doc that matches tagName
 MethodDoc getWriteMethod()
           
 boolean isBound()
           
 boolean isConstrained()
           
 boolean isDefault()
           
 boolean isMethod()
           
 boolean isTagPresent(java.lang.String tagName)
          Checks to see if the specified tag exists
 void setName(java.lang.String name)
           
 void setReadMethod(MethodDoc doc)
           
 void setWriteMethod(MethodDoc doc)
           
 
Methods inherited from class com.go.beandoc.teadoc.MemberDoc
getContainingPackage, isExcluded, isExpert, isHidden, isPreferred, isSynthetic
 
Methods inherited from class com.go.beandoc.teadoc.ProgramElementDoc
getContainingClass, getModifiers, getModifierSpecifier, getQualifiedName, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic
 
Methods inherited from class com.go.beandoc.teadoc.Doc
compareTo, equals, getFirstSentenceTags, getInlineTags, getInnerDoc, getPath, getRawCommentText, getRootDoc, getSeeTags, getTagMap, getTags, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isOrdinaryClass, parseName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyDoc

public PropertyDoc(RootDoc root,
                   MethodDoc methodDoc,
                   boolean isReadMethod)
Method Detail

create

public static PropertyDoc[] create(RootDoc root,
                                   MethodDoc[] docs)
Creates a set of PropertyDoc objects from the specified MemberDocs. A single PropertyDoc object will be created for each pair of get/set methods.

getName

public java.lang.String getName()
Overrides:
getName in class Doc

setName

public void setName(java.lang.String name)

getReadMethod

public MethodDoc getReadMethod()

setReadMethod

public void setReadMethod(MethodDoc doc)

getWriteMethod

public MethodDoc getWriteMethod()

setWriteMethod

public void setWriteMethod(MethodDoc doc)

getCommentText

public java.lang.String getCommentText()
Overrides:
getCommentText in class Doc

isBound

public boolean isBound()

isConstrained

public boolean isConstrained()

isDefault

public boolean isDefault()

getPropertyEditorClassName

public java.lang.String getPropertyEditorClassName()

isMethod

public boolean isMethod()
Overrides:
isMethod in class Doc

isTagPresent

public boolean isTagPresent(java.lang.String tagName)
Checks to see if the specified tag exists
Overrides:
isTagPresent in class Doc

getTagValue

public java.lang.String getTagValue(java.lang.String tagName)
Description copied from class: Doc
Gets the text value of the first tag in doc that matches tagName
Overrides:
getTagValue in class Doc