KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > javadoc > PackageDoc


1 /*
2  * @(#)PackageDoc.java 1.9 02/09/29
3  *
4  * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6  */
7
8 package com.sun.javadoc;
9
10 /**
11  * Represents a java package. Provides access to information
12  * about the package, the package's comment and tags, and the
13  * classes in the package.
14  * <p>
15  * Each method whose return type is an array will return an empty
16  * array (never null) when there are no objects in the result.
17  *
18  * @since JDK1.2
19  * @author Kaiyang Liu (original)
20  * @author Robert Field (rewrite)
21  */
22 public interface PackageDoc extends Doc {
23
24     /**
25      * Get all classes and interfaces in the package, filtered to the specified
26      * <a HREF="{@docRoot}/com/sun/javadoc/package-summary.html#included">access
27      * modifier option</a>.
28      *
29      * @return filtered classes and interfaces in this package
30      * @param filter Specifying true filters according to the specified access
31      * modifier option.
32      * Specifying false includes all classes and interfaces
33      * regardless of access modifier option.
34      * @since 1.4
35      */
36     ClassDoc[] allClasses(boolean filter);
37
38     /**
39      * Get all
40      * <a HREF="{@docRoot}/com/sun/javadoc/package-summary.html#included">included</a>
41      * classes and interfaces in the package. Same as allClasses(true).
42      *
43      * @return all included classes and interfaces in this package.
44      */
45     ClassDoc[] allClasses();
46
47     /**
48      * Get included
49      * <a HREF="{@docRoot}/com/sun/javadoc/package-summary.html#class">ordinary</a>
50      * classes (that is, exclude exceptions, errors, enums, interfaces, and
51      * annotation types)
52      * in this package.
53      *
54      * @return included ordinary classes in this package.
55      */
56     ClassDoc[] ordinaryClasses();
57
58     /**
59      * Get included Exception classes in this package.
60      *
61      * @return included Exceptions in this package.
62      */
63     ClassDoc[] exceptions();
64
65     /**
66      * Get included Error classes in this package.
67      *
68      * @return included Errors in this package.
69      */
70     ClassDoc[] errors();
71
72     /**
73      * Get included enum types in this package.
74      *
75      * @return included enum types in this package.
76      * @since 1.5
77      */
78     ClassDoc[] enums();
79
80     /**
81      * Get included interfaces in this package, omitting annotation types.
82      *
83      * @return included interfaces in this package.
84      */
85     ClassDoc[] interfaces();
86
87     /**
88      * Get included annotation types in this package.
89      *
90      * @return included annotation types in this package.
91      * @since 1.5
92      */
93     AnnotationTypeDoc[] annotationTypes();
94
95     /**
96      * Get the annotations of this package.
97      * Return an empty array if there are none.
98      *
99      * @return the annotations of this package.
100      * @since 1.5
101      */
102     AnnotationDesc[] annotations();
103
104     /**
105      * Lookup a class or interface within this package.
106      *
107      * @return ClassDoc of found class or interface,
108      * or null if not found.
109      */
110     ClassDoc findClass(String JavaDoc className);
111 }
112
Popular Tags