Tue, 16 Sep 2008 18:35:18 -0700
6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
Reviewed-by: darcy, mcimadamore
1 /*
2 * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * 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 */
26 package com.sun.mirror.declaration;
29 import java.util.Collection;
32 /**
33 * Represents the declaration of a package. Provides access to information
34 * about the package and its members.
35 *
36 * <p> {@link com.sun.mirror.util.DeclarationFilter}
37 * provides a simple way to select just the items of interest
38 * when a method returns a collection of declarations.
39 *
40 * @author Joseph D. Darcy
41 * @author Scott Seligman
42 * @since 1.5
43 */
45 public interface PackageDeclaration extends Declaration {
47 /**
48 * Returns the fully qualified name of this package.
49 * This is also known as the package's <i>canonical</i> name.
50 *
51 * @return the fully qualified name of this package, or the
52 * empty string if this is the unnamed package
53 */
54 String getQualifiedName();
56 /**
57 * Returns the declarations of the top-level classes in this package.
58 * Interfaces are not included, but enum types are.
59 *
60 * @return the declarations of the top-level classes in this package
61 *
62 * @see com.sun.mirror.util.DeclarationFilter
63 */
64 Collection<ClassDeclaration> getClasses();
66 /**
67 * Returns the declarations of the top-level enum types in this package.
68 *
69 * @return the declarations of the top-level enum types in this package
70 *
71 * @see com.sun.mirror.util.DeclarationFilter
72 */
73 Collection<EnumDeclaration> getEnums();
75 /**
76 * Returns the declarations of the top-level interfaces in this package.
77 * Annotation types are included.
78 *
79 * @return the declarations of the top-level interfaces in this package
80 *
81 * @see com.sun.mirror.util.DeclarationFilter
82 */
83 Collection<InterfaceDeclaration> getInterfaces();
85 /**
86 * Returns the declarations of the top-level annotation types in this
87 * package.
88 *
89 * @return the declarations of the top-level annotation types in this
90 * package
91 *
92 * @see com.sun.mirror.util.DeclarationFilter
93 */
94 Collection<AnnotationTypeDeclaration> getAnnotationTypes();
95 }