01: /*
02: * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun in the LICENSE file that accompanied this code.
10: *
11: * This code is distributed in the hope that it will be useful, but WITHOUT
12: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14: * version 2 for more details (a copy is included in the LICENSE file that
15: * accompanied this code).
16: *
17: * You should have received a copy of the GNU General Public License version
18: * 2 along with this work; if not, write to the Free Software Foundation,
19: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20: *
21: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.mirror.declaration;
27:
28: import java.util.Collection;
29:
30: /**
31: * Represents the declaration of a package. Provides access to information
32: * about the package and its members.
33: *
34: * <p> {@link com.sun.mirror.util.DeclarationFilter}
35: * provides a simple way to select just the items of interest
36: * when a method returns a collection of declarations.
37: *
38: * @author Joseph D. Darcy
39: * @author Scott Seligman
40: * @version 1.8 07/05/05
41: * @since 1.5
42: */
43:
44: public interface PackageDeclaration extends Declaration {
45:
46: /**
47: * Returns the fully qualified name of this package.
48: * This is also known as the package's <i>canonical</i> name.
49: *
50: * @return the fully qualified name of this package, or the
51: * empty string if this is the unnamed package
52: */
53: String getQualifiedName();
54:
55: /**
56: * Returns the declarations of the top-level classes in this package.
57: * Interfaces are not included, but enum types are.
58: *
59: * @return the declarations of the top-level classes in this package
60: *
61: * @see com.sun.mirror.util.DeclarationFilter
62: */
63: Collection<ClassDeclaration> getClasses();
64:
65: /**
66: * Returns the declarations of the top-level enum types in this package.
67: *
68: * @return the declarations of the top-level enum types in this package
69: *
70: * @see com.sun.mirror.util.DeclarationFilter
71: */
72: Collection<EnumDeclaration> getEnums();
73:
74: /**
75: * Returns the declarations of the top-level interfaces in this package.
76: * Annotation types are included.
77: *
78: * @return the declarations of the top-level interfaces in this package
79: *
80: * @see com.sun.mirror.util.DeclarationFilter
81: */
82: Collection<InterfaceDeclaration> getInterfaces();
83:
84: /**
85: * Returns the declarations of the top-level annotation types in this
86: * package.
87: *
88: * @return the declarations of the top-level annotation types in this
89: * package
90: *
91: * @see com.sun.mirror.util.DeclarationFilter
92: */
93: Collection<AnnotationTypeDeclaration> getAnnotationTypes();
94: }
|