Class PackageDocImpl
java.lang.Object
gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
gw.gosudoc.com.sun.tools.javadoc.main.PackageDocImpl
- All Implemented Interfaces:
Doc
,PackageDoc
,Comparable<Object>
Deprecated.
Represents a java package. Provides access to information
about the package, the package's comment and tags, and the
classes in the package.
This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.
- Since:
- 1.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate com.sun.tools.javac.util.List<ClassDocImpl>
Deprecated.Cache of all classes contained in this package, including member classes of those classes, and their member classes, etc.private com.sun.tools.javac.util.List<ClassDocImpl>
Deprecated.Cache of all classes contained in this package, including member classes of those classes, and their member classes, etc.private boolean
Deprecated.Deprecated.private boolean
Deprecated.(package private) boolean
Deprecated.private String
Deprecated.boolean
Deprecated.final com.sun.tools.javac.code.Symbol.PackageSymbol
Deprecated.private com.sun.tools.javac.tree.JCTree.JCCompilationUnit
Deprecated.Fields inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
documentation, env, treePath
-
Constructor Summary
ConstructorsConstructorDescriptionPackageDocImpl
(DocEnv env, com.sun.tools.javac.code.Symbol.PackageSymbol sym) Deprecated.ConstructorPackageDocImpl
(DocEnv env, com.sun.tools.javac.code.Symbol.PackageSymbol sym, com.sun.source.util.TreePath treePath) Deprecated.Constructor -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAllClassesTo
(com.sun.tools.javac.util.ListBuffer<ClassDocImpl> list) Deprecated.Add all included classes (including Exceptions and Errors) and interfaces.ClassDoc[]
Deprecated.Get all included classes (including Exceptions and Errors) and interfaces.ClassDoc[]
allClasses
(boolean filter) Deprecated.Get all classes (including Exceptions and Errors) and interfaces.Deprecated.Get the annotations of this package.Deprecated.Get included annotation types in this package.private void
checkDoc()
Deprecated.Invoked when a source of package doc comments is located.protected String
Deprecated.Do lazy initialization of "documentation" string.ClassDoc[]
enums()
Deprecated.Get included enum types in this package.ClassDoc[]
errors()
Deprecated.Get Error classes in this package.ClassDoc[]
Deprecated.Get Exception classes in this package.Deprecated.Lookup for a class within this package.private com.sun.tools.javac.util.List<ClassDocImpl>
getClasses
(boolean filtered) Deprecated.Return a list of all classes contained in this package, including member classes of those classes, and their member classes, etc.ClassDoc[]
Deprecated.Get included interfaces in this package, omitting annotation types.boolean
Deprecated.Return true if this package is included in the active set.name()
Deprecated.Get package name.ClassDoc[]
Deprecated.Get ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package.position()
Deprecated.Return the source position of the entity, or null if no position is available.Deprecated.Get package name.void
setDocPath
(FileObject path) Deprecated.set doc path for an unzipped directory(package private) void
setTree
(com.sun.tools.javac.tree.JCTree tree) Deprecated.void
setTreePath
(com.sun.source.util.TreePath treePath) Deprecated.Set the full unprocessed text of the comment and tree path.Methods inherited from class gw.gosudoc.com.sun.tools.javadoc.main.DocImpl
comment, commentText, compareTo, firstSentenceTags, generateKey, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isInterface, isMethod, isOrdinaryClass, key, readHTMLDocumentation, seeTags, setRawCommentText, tags, tags, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface gw.gosudoc.com.sun.javadoc.Doc
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isInterface, isMethod, isOrdinaryClass, seeTags, setRawCommentText, tags, tags
-
Field Details
-
sym
public final com.sun.tools.javac.code.Symbol.PackageSymbol symDeprecated. -
tree
private com.sun.tools.javac.tree.JCTree.JCCompilationUnit treeDeprecated. -
docPath
Deprecated. -
foundDoc
private boolean foundDocDeprecated. -
isIncluded
boolean isIncludedDeprecated. -
setDocPath
public boolean setDocPathDeprecated. -
allClassesFiltered
Deprecated.Cache of all classes contained in this package, including member classes of those classes, and their member classes, etc. Includes only those classes at the specified protection level and weaker. -
allClasses
Deprecated.Cache of all classes contained in this package, including member classes of those classes, and their member classes, etc. -
qualifiedName
Deprecated. -
checkDocWarningEmitted
private boolean checkDocWarningEmittedDeprecated.
-
-
Constructor Details
-
PackageDocImpl
Deprecated.Constructor -
PackageDocImpl
public PackageDocImpl(DocEnv env, com.sun.tools.javac.code.Symbol.PackageSymbol sym, com.sun.source.util.TreePath treePath) Deprecated.Constructor
-
-
Method Details
-
setTree
void setTree(com.sun.tools.javac.tree.JCTree tree) Deprecated. -
setTreePath
public void setTreePath(com.sun.source.util.TreePath treePath) Deprecated.Description copied from class:DocImpl
Set the full unprocessed text of the comment and tree path.- Overrides:
setTreePath
in classDocImpl
-
documentation
Deprecated.Do lazy initialization of "documentation" string.- Overrides:
documentation
in classDocImpl
-
getClasses
Deprecated.Return a list of all classes contained in this package, including member classes of those classes, and their member classes, etc. -
addAllClassesTo
Deprecated.Add all included classes (including Exceptions and Errors) and interfaces. -
allClasses
Deprecated.Get all classes (including Exceptions and Errors) and interfaces.- Specified by:
allClasses
in interfacePackageDoc
- Parameters:
filter
- Specifying true filters according to the specified access modifier option. Specifying false includes all classes and interfaces regardless of access modifier option.- Returns:
- all classes and interfaces in this package, filtered to include only the included classes if filter==true.
- Since:
- J2SE1.4.
-
allClasses
Deprecated.Get all included classes (including Exceptions and Errors) and interfaces. Same as allClasses(true).- Specified by:
allClasses
in interfacePackageDoc
- Returns:
- all included classes and interfaces in this package.
-
ordinaryClasses
Deprecated.Get ordinary classes (that is, exclude exceptions, errors, enums, interfaces, and annotation types) in this package.- Specified by:
ordinaryClasses
in interfacePackageDoc
- Returns:
- included ordinary classes in this package.
-
exceptions
Deprecated.Get Exception classes in this package.- Specified by:
exceptions
in interfacePackageDoc
- Returns:
- included Exceptions in this package.
-
errors
Deprecated.Get Error classes in this package.- Specified by:
errors
in interfacePackageDoc
- Returns:
- included Errors in this package.
-
enums
Deprecated.Get included enum types in this package.- Specified by:
enums
in interfacePackageDoc
- Returns:
- included enum types in this package.
-
interfaces
Deprecated.Get included interfaces in this package, omitting annotation types.- Specified by:
interfaces
in interfacePackageDoc
- Returns:
- included interfaces in this package.
-
annotationTypes
Deprecated.Get included annotation types in this package.- Specified by:
annotationTypes
in interfacePackageDoc
- Returns:
- included annotation types in this package.
-
annotations
Deprecated.Get the annotations of this package. Return an empty array if there are none.- Specified by:
annotations
in interfacePackageDoc
- Returns:
- the annotations of this package.
-
findClass
Deprecated.Lookup for a class within this package.- Specified by:
findClass
in interfacePackageDoc
- Parameters:
className
- A String containing the name of the class to look up.- Returns:
- ClassDocImpl of found class, or null if not found.
-
isIncluded
public boolean isIncluded()Deprecated.Return true if this package is included in the active set.- Specified by:
isIncluded
in interfaceDoc
- Specified by:
isIncluded
in classDocImpl
- Returns:
- true if this Doc item is included in the result set.
-
name
Deprecated.Get package name. Note that we do not provide a means of obtaining the simple name of a package -- package names are always returned in their uniquely qualified form. -
qualifiedName
Deprecated.Get package name.- Specified by:
qualifiedName
in classDocImpl
- Returns:
- the name
-
setDocPath
Deprecated.set doc path for an unzipped directory -
checkDoc
private void checkDoc()Deprecated.Invoked when a source of package doc comments is located. Emits a diagnostic if this is the second one. -
position
Deprecated.Return the source position of the entity, or null if no position is available.
-