Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.PackageDoc

java.lang.Object
    |
    +----sun.tools.javadoc.Doc
            |
            +----sun.tools.javadoc.PackageDoc

public class PackageDoc
extends Doc
Represents a java package. Provides access to information about the package, the package's comment and tags, and the classes in the package.

Since:
JDK1.2

Method Summary
ClassDoc[]  allClasses()
Get all classes (including Exceptions and Errors) and interfaces.
ClassDoc[]  errors()
Get Error classes in this package.
ClassDoc[]  exceptions()
Get Exception classes in this package.
ClassDoc[]  interfaces()
Get Interfaces in this package.
boolean  isIncluded()
return true if this package is include in the active set.
java.lang.String  name()
Get package name.
ClassDoc[]  ordinaryClasses()
Get ordinary classes (excluding Exceptions and Errors) in this package.
java.lang.String  toString()
Returns a string representation of the package.
 
Methods inherited from class sun.tools.javadoc.Doc
 commentText, compareTo, getRawCommentText, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags, toString
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

name

public java.lang.String name()
Get package name.
Overrides:
name in class Doc

allClasses

public ClassDoc[] allClasses()
Get all classes (including Exceptions and Errors) and interfaces.
Returns:
all included classes and interfaces in this package.

ordinaryClasses

public ClassDoc[] ordinaryClasses()
Get ordinary classes (excluding Exceptions and Errors) in this package.
Returns:
included classes in this package.

exceptions

public ClassDoc[] exceptions()
Get Exception classes in this package.
Returns:
included Exceptions in this package.

errors

public ClassDoc[] errors()
Get Error classes in this package.
Returns:
included Errors in this package.

interfaces

public ClassDoc[] interfaces()
Get Interfaces in this package.
Returns:
included Errors in this package.

isIncluded

public boolean isIncluded()
return true if this package is include in the active set.
Overrides:
isIncluded in class Doc

toString

public java.lang.String toString()
Returns a string representation of the package.
Returns:
the package name.
Overrides:
toString in class Doc

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS