Java Doc for ClassDocCatalog.java in  » 6.0-JDK-Modules-com.sun » tools » com » sun » tools » doclets » internal » toolkit » util » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules com.sun » tools » com.sun.tools.doclets.internal.toolkit.util 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sun.tools.doclets.internal.toolkit.util.ClassDocCatalog

ClassDocCatalog
public class ClassDocCatalog (Code)
This class acts as an artificial PackageDoc for classes specified on the command line when running Javadoc. For example, if you specify several classes from package java.lang, this class will catalog those classes so that we can retrieve all of the classes from a particular package later. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API
author:
   Jamie Ho
since:
   1.4



Constructor Summary
public  ClassDocCatalog(ClassDoc[] classdocs)
     Construct a new ClassDocCatalog.
public  ClassDocCatalog()
     Construct a new ClassDocCatalog.

Method Summary
public  voidaddClassDoc(ClassDoc classdoc)
     Add the given class to the catalog.
public  ClassDoc[]allClasses(PackageDoc pkgDoc)
     Return all of the classes specified on the command-line that belong to the given package.
public  ClassDoc[]allClasses(String packageName)
     Return all of the classes specified on the command-line that belong to the given package.
public  ClassDoc[]annotationTypes(String packageName)
     Return all of the annotation types specified on the command-line that belong to the given package.
public  ClassDoc[]enums(String packageName)
     Return all of the enums specified on the command-line that belong to the given package.
public  ClassDoc[]errors(String packageName)
     Return all of the errors specified on the command-line that belong to the given package.
public  ClassDoc[]exceptions(String packageName)
     Return all of the exceptions specified on the command-line that belong to the given package.
public  ClassDoc[]interfaces(String packageName)
     Return all of the interfaces specified on the command-line that belong to the given package.
public  booleanisKnownPackage(String packageName)
     Return true if the given package is known to this catalog.
Parameters:
  packageName - the name to check.
public  ClassDoc[]ordinaryClasses(String packageName)
     Return all of the ordinary classes specified on the command-line that belong to the given package.
public  String[]packageNames()
     Return the array of package names that this catalog stores ClassDocs for.


Constructor Detail
ClassDocCatalog
public ClassDocCatalog(ClassDoc[] classdocs)(Code)
Construct a new ClassDocCatalog.
Parameters:
  classdocs - the array of ClassDocs to catalog



ClassDocCatalog
public ClassDocCatalog()(Code)
Construct a new ClassDocCatalog.




Method Detail
addClassDoc
public void addClassDoc(ClassDoc classdoc)(Code)
Add the given class to the catalog.
Parameters:
  classdoc - the ClassDoc to add to the catelog.



allClasses
public ClassDoc[] allClasses(PackageDoc pkgDoc)(Code)
Return all of the classes specified on the command-line that belong to the given package.
Parameters:
  packageDoc - the package to return the classes for.



allClasses
public ClassDoc[] allClasses(String packageName)(Code)
Return all of the classes specified on the command-line that belong to the given package.
Parameters:
  packageName - the name of the package specified on thecommand-line.



annotationTypes
public ClassDoc[] annotationTypes(String packageName)(Code)
Return all of the annotation types specified on the command-line that belong to the given package.
Parameters:
  packageName - the name of the package specified on thecommand-line.



enums
public ClassDoc[] enums(String packageName)(Code)
Return all of the enums specified on the command-line that belong to the given package.
Parameters:
  packageName - the name of the package specified on thecommand-line.



errors
public ClassDoc[] errors(String packageName)(Code)
Return all of the errors specified on the command-line that belong to the given package.
Parameters:
  packageName - the name of the package specified on thecommand-line.



exceptions
public ClassDoc[] exceptions(String packageName)(Code)
Return all of the exceptions specified on the command-line that belong to the given package.
Parameters:
  packageName - the name of the package specified on thecommand-line.



interfaces
public ClassDoc[] interfaces(String packageName)(Code)
Return all of the interfaces specified on the command-line that belong to the given package.
Parameters:
  packageName - the name of the package specified on thecommand-line.



isKnownPackage
public boolean isKnownPackage(String packageName)(Code)
Return true if the given package is known to this catalog.
Parameters:
  packageName - the name to check. true if this catalog has any information aboutclasses in the given package.



ordinaryClasses
public ClassDoc[] ordinaryClasses(String packageName)(Code)
Return all of the ordinary classes specified on the command-line that belong to the given package.
Parameters:
  packageName - the name of the package specified on thecommand-line.



packageNames
public String[] packageNames()(Code)
Return the array of package names that this catalog stores ClassDocs for.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

ww__w_.___j_av___a__2__s__._c__om | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.