net.cscott.sinjdoc

Interface PackageDoc

public interface PackageDoc extends Doc

The PackageDoc class represents a java package. It provides access to information about the package, the package's comment and tags, and the classes in the package. It does *not* necessarily represent a package included in the current SinjDoc run.

Version: $Id: PackageDoc.java,v 1.7 2003/05/08 03:54:25 cananian Exp $

Author: C. Scott Ananian (cscott@cscott.net)

See Also: com.sun.javadoc.PackageDoc

Method Summary
List<ClassType>allClasses()
Return all classes in this package, including exceptions, errors, and interfaces, and classes which aren't being documented.
ClassDocfindClass(String className)
Lookup a class within this package.
List<ClassDoc>includedClasses()
Return all included classes and interfaces in this package, including exceptions and errors.
List<ClassDoc>includedErrors()
Return all included error classes in this package.
List<ClassDoc>includedExceptions()
Return all included exception classes in this package.
List<ClassDoc>includedInterfaces()
Return all included interfaces in this package.
List<ClassDoc>includedOrdinaryClasses()
Return all included non-interface classes in this package which are not errors or exceptions.

Method Detail

allClasses

public List<ClassType> allClasses()
Return all classes in this package, including exceptions, errors, and interfaces, and classes which aren't being documented.

findClass

public ClassDoc findClass(String className)
Lookup a class within this package. Returns null if the class is not found.

includedClasses

public List<ClassDoc> includedClasses()
Return all included classes and interfaces in this package, including exceptions and errors.

includedErrors

public List<ClassDoc> includedErrors()
Return all included error classes in this package.

includedExceptions

public List<ClassDoc> includedExceptions()
Return all included exception classes in this package.

includedInterfaces

public List<ClassDoc> includedInterfaces()
Return all included interfaces in this package.

includedOrdinaryClasses

public List<ClassDoc> includedOrdinaryClasses()
Return all included non-interface classes in this package which are not errors or exceptions.
Copyright © 2003 C. Scott Ananian