com.go.beandoc.teadoc
Class EmptyPackageDoc

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

public class EmptyPackageDoc
extends PackageDoc

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
EmptyPackageDoc(RootDoc root, java.lang.String name)
           
 
Method Summary
 int compareTo(java.lang.Object obj)
           
 ClassDoc[] getAllClasses()
           
 java.lang.String getCommentText()
           
 ClassDoc[] getErrors()
           
 ClassDoc[] getExceptions()
           
 Tag[] getFirstSentanceTags()
           
 Tag[] getInlineTags()
           
 ClassDoc[] getInterfaces()
           
 java.lang.String getName()
           
 ClassDoc[] getOrdinaryClasses()
           
 java.lang.String getRawCommentText()
           
 SeeTag[] getSeeTags()
           
 Tag[] getTags()
           
 boolean isClass()
           
 boolean isConstructor()
           
 boolean isError()
           
 boolean isException()
           
 boolean isField()
           
 boolean isIncluded()
           
 boolean isInterface()
           
 boolean isMethod()
           
 boolean isOrdinaryClass()
           
 
Methods inherited from class com.go.beandoc.teadoc.PackageDoc
convert, equals, getPackages, getSortedAllClasses, getSortedErrors, getSortedExceptions, getSortedInterfaces, getSortedOrdinaryClasses, getSortedPackages, hashCode
 
Methods inherited from class com.go.beandoc.teadoc.Doc
getFirstSentenceTags, getInnerDoc, getPath, getRootDoc, getTagMap, getTagValue, isTagPresent, parseName
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EmptyPackageDoc

public EmptyPackageDoc(RootDoc root,
                       java.lang.String name)
Method Detail

getCommentText

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

getTags

public Tag[] getTags()
Overrides:
getTags in class Doc

getSeeTags

public SeeTag[] getSeeTags()
Overrides:
getSeeTags in class Doc

getInlineTags

public Tag[] getInlineTags()
Overrides:
getInlineTags in class Doc

getFirstSentanceTags

public Tag[] getFirstSentanceTags()

getRawCommentText

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

getName

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

compareTo

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

isField

public boolean isField()
Overrides:
isField in class Doc

isMethod

public boolean isMethod()
Overrides:
isMethod in class Doc

isConstructor

public boolean isConstructor()
Overrides:
isConstructor in class Doc

isInterface

public boolean isInterface()
Overrides:
isInterface in class Doc

isException

public boolean isException()
Overrides:
isException in class Doc

isError

public boolean isError()
Overrides:
isError in class Doc

isOrdinaryClass

public boolean isOrdinaryClass()
Overrides:
isOrdinaryClass in class Doc

isClass

public boolean isClass()
Overrides:
isClass in class Doc

isIncluded

public boolean isIncluded()
Overrides:
isIncluded in class Doc

getAllClasses

public ClassDoc[] getAllClasses()
Overrides:
getAllClasses in class PackageDoc

getOrdinaryClasses

public ClassDoc[] getOrdinaryClasses()
Overrides:
getOrdinaryClasses in class PackageDoc

getExceptions

public ClassDoc[] getExceptions()
Overrides:
getExceptions in class PackageDoc

getErrors

public ClassDoc[] getErrors()
Overrides:
getErrors in class PackageDoc

getInterfaces

public ClassDoc[] getInterfaces()
Overrides:
getInterfaces in class PackageDoc