com.go.beandoc.teadoc
Class ClassDoc

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

public class ClassDoc
extends ProgramElementDoc

Version:
6 , 8/23/00
Author:
Brian S O'Neill
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
ClassDoc(RootDoc root, com.sun.javadoc.ClassDoc doc)
           
 
Method Summary
static ClassDoc[] convert(RootDoc root, com.sun.javadoc.ClassDoc[] docs)
           
 MethodDoc findMatchingMethod(MethodDoc method, MethodFinder mf)
          Find a MethodDoc with a name and signature matching that of the specified MethodDoc and accepted by the specified MethodFinder.
 ClassDoc getAsClassDoc()
           
 ConstructorDoc[] getConstructors()
           
 PackageDoc getContainingPackage()
           
 boolean getDefinesSerializableFields()
           
 java.lang.String getDimension()
           
 FieldDoc[] getFields()
           
 ClassDoc[] getImportedClasses()
           
 PackageDoc[] getImportedPackages()
           
 ClassDoc[] getInnerClasses()
           
 ClassDoc[] getInterfaces()
           
 MethodDoc getMatchingMethod(MethodDoc method)
          Get a MethodDoc in this ClassDoc with a name and signature matching that of the specified MethodDoc
 MethodDoc getMatchingMethod(MethodDoc method, MethodFinder mf)
          Get a MethodDoc in this ClassDoc with a name and signature matching that of the specified MethodDoc and accepted by the specified MethodFinder
 MethodDoc[] getMethods()
           
 java.lang.String getPackageName()
          Returns the package name.
 java.lang.String[] getPath()
           
 PropertyDoc[] getProperties()
           
 java.lang.String getQualifiedTypeName()
           
 java.lang.String getQualifiedTypeNameForFile()
          Converts inner class names.
 FieldDoc[] getSerializableFields()
           
 MethodDoc[] getSerializationMethods()
           
 ConstructorDoc[] getSortedConstructors()
           
 FieldDoc[] getSortedFields()
           
 ClassDoc[] getSortedInnerClasses()
           
 MethodDoc[] getSortedMethods()
           
 PropertyDoc[] getSortedProperties()
           
 ClassDoc getSuperclass()
           
 java.lang.String getTypeName()
           
 java.lang.String getTypeNameForFile()
          Converts inner class names (replaces '.' with '$').
 boolean isAbstract()
           
 boolean isExternalizable()
           
 boolean isSerializable()
           
static java.lang.String[] parseClassName(java.lang.String fullClassName)
          Splits a class name into two strings.
 java.lang.String toString()
           
 
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, getCommentText, getFirstSentenceTags, getInlineTags, getInnerDoc, getName, getRawCommentText, getRootDoc, getSeeTags, getTagMap, getTags, getTagValue, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, isTagPresent, parseName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ClassDoc

public ClassDoc(RootDoc root,
                com.sun.javadoc.ClassDoc doc)
Method Detail

convert

public static ClassDoc[] convert(RootDoc root,
                                 com.sun.javadoc.ClassDoc[] docs)

parseClassName

public static java.lang.String[] parseClassName(java.lang.String fullClassName)
Splits a class name into two strings.
[0] = package name (or null if the class is unpackaged)
[1] = class name

isAbstract

public boolean isAbstract()

isSerializable

public boolean isSerializable()

isExternalizable

public boolean isExternalizable()

getSerializationMethods

public MethodDoc[] getSerializationMethods()

getSerializableFields

public FieldDoc[] getSerializableFields()

getDefinesSerializableFields

public boolean getDefinesSerializableFields()

getContainingPackage

public PackageDoc getContainingPackage()

getPath

public java.lang.String[] getPath()
Overrides:
getPath in class Doc

getSuperclass

public ClassDoc getSuperclass()

getInterfaces

public ClassDoc[] getInterfaces()

getFields

public FieldDoc[] getFields()

getSortedFields

public FieldDoc[] getSortedFields()

getMethods

public MethodDoc[] getMethods()

getSortedMethods

public MethodDoc[] getSortedMethods()

getProperties

public PropertyDoc[] getProperties()

getSortedProperties

public PropertyDoc[] getSortedProperties()

getConstructors

public ConstructorDoc[] getConstructors()

getSortedConstructors

public ConstructorDoc[] getSortedConstructors()

getInnerClasses

public ClassDoc[] getInnerClasses()

getSortedInnerClasses

public ClassDoc[] getSortedInnerClasses()

getImportedClasses

public ClassDoc[] getImportedClasses()

getImportedPackages

public PackageDoc[] getImportedPackages()

getTypeName

public java.lang.String getTypeName()

getQualifiedTypeName

public java.lang.String getQualifiedTypeName()

getTypeNameForFile

public java.lang.String getTypeNameForFile()
Converts inner class names (replaces '.' with '$').

getQualifiedTypeNameForFile

public java.lang.String getQualifiedTypeNameForFile()
Converts inner class names.

getPackageName

public java.lang.String getPackageName()
Returns the package name. Returns null if the class is unpackaged.

getDimension

public java.lang.String getDimension()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getAsClassDoc

public ClassDoc getAsClassDoc()

getMatchingMethod

public MethodDoc getMatchingMethod(MethodDoc method)
Get a MethodDoc in this ClassDoc with a name and signature matching that of the specified MethodDoc

getMatchingMethod

public MethodDoc getMatchingMethod(MethodDoc method,
                                   MethodFinder mf)
Get a MethodDoc in this ClassDoc with a name and signature matching that of the specified MethodDoc and accepted by the specified MethodFinder

findMatchingMethod

public MethodDoc findMatchingMethod(MethodDoc method,
                                    MethodFinder mf)
Find a MethodDoc with a name and signature matching that of the specified MethodDoc and accepted by the specified MethodFinder. This method searches the interfaces and super class ancestry of the class represented by this ClassDoc for a matching method.