src/share/classes/com/sun/mirror/declaration/PackageDeclaration.java

Tue, 16 Sep 2008 18:35:18 -0700

author
jjg
date
Tue, 16 Sep 2008 18:35:18 -0700
changeset 113
eff38cc97183
parent 1
9a66ca7c79fa
child 331
d043adadc8b6
permissions
-rw-r--r--

6574134: Allow for alternative implementation of Name Table with garbage collection of name bytes
Reviewed-by: darcy, mcimadamore

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

mercurial