com.go.beandoc.teadoc
Class PackageDoc

java.lang.Object
  |
  +--com.go.beandoc.teadoc.Doc
        |
        +--com.go.beandoc.teadoc.PackageDoc
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable
Direct Known Subclasses:
EmptyPackageDoc

public class PackageDoc
extends Doc

Version:
3 , 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
PackageDoc(RootDoc root, com.sun.javadoc.PackageDoc doc)
           
 
Method Summary
 int compareTo(java.lang.Object obj)
           
static PackageDoc[] convert(RootDoc root, com.sun.javadoc.PackageDoc[] docs)
           
 boolean equals(java.lang.Object other)
           
 ClassDoc[] getAllClasses()
           
 ClassDoc[] getErrors()
           
 ClassDoc[] getExceptions()
           
 ClassDoc[] getInterfaces()
           
 ClassDoc[] getOrdinaryClasses()
           
 PackageDoc[] getPackages()
           
 ClassDoc[] getSortedAllClasses()
           
 ClassDoc[] getSortedErrors()
           
 ClassDoc[] getSortedExceptions()
           
 ClassDoc[] getSortedInterfaces()
           
 ClassDoc[] getSortedOrdinaryClasses()
           
 PackageDoc[] getSortedPackages()
           
 int hashCode()
           
 
Methods inherited from class com.go.beandoc.teadoc.Doc
getCommentText, getFirstSentenceTags, getInlineTags, getInnerDoc, getName, getPath, 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, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PackageDoc

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

convert

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

getAllClasses

public ClassDoc[] getAllClasses()

getSortedAllClasses

public ClassDoc[] getSortedAllClasses()

getOrdinaryClasses

public ClassDoc[] getOrdinaryClasses()

getSortedOrdinaryClasses

public ClassDoc[] getSortedOrdinaryClasses()

getExceptions

public ClassDoc[] getExceptions()

getSortedExceptions

public ClassDoc[] getSortedExceptions()

getErrors

public ClassDoc[] getErrors()

getSortedErrors

public ClassDoc[] getSortedErrors()

getInterfaces

public ClassDoc[] getInterfaces()

getSortedInterfaces

public ClassDoc[] getSortedInterfaces()

getPackages

public PackageDoc[] getPackages()

getSortedPackages

public PackageDoc[] getSortedPackages()

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class Doc

compareTo

public int compareTo(java.lang.Object obj)
Overrides:
compareTo in class Doc