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
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 | import com.sun.mirror.type.ClassType; |
duke@1 | 32 | |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * Represents the declaration of a class. |
duke@1 | 36 | * For the declaration of an interface, see {@link InterfaceDeclaration}. |
duke@1 | 37 | * Provides access to information about the class, its members, and |
duke@1 | 38 | * its constructors. |
duke@1 | 39 | * Note that an {@linkplain EnumDeclaration enum} is a kind of class. |
duke@1 | 40 | * |
duke@1 | 41 | * <p> While a <tt>ClassDeclaration</tt> represents the <i>declaration</i> |
duke@1 | 42 | * of a class, a {@link ClassType} represents a class <i>type</i>. |
duke@1 | 43 | * See {@link TypeDeclaration} for more on this distinction. |
duke@1 | 44 | * |
duke@1 | 45 | * <p> {@link com.sun.mirror.util.DeclarationFilter} |
duke@1 | 46 | * provides a simple way to select just the items of interest |
duke@1 | 47 | * when a method returns a collection of declarations. |
duke@1 | 48 | * |
duke@1 | 49 | * @author Joseph D. Darcy |
duke@1 | 50 | * @author Scott Seligman |
duke@1 | 51 | * |
duke@1 | 52 | * @see ClassType |
duke@1 | 53 | * @since 1.5 |
duke@1 | 54 | */ |
duke@1 | 55 | |
duke@1 | 56 | public interface ClassDeclaration extends TypeDeclaration { |
duke@1 | 57 | |
duke@1 | 58 | /** |
duke@1 | 59 | * Returns the class type directly extended by this class. |
duke@1 | 60 | * The only class with no superclass is <tt>java.lang.Object</tt>, |
duke@1 | 61 | * for which this method returns null. |
duke@1 | 62 | * |
duke@1 | 63 | * @return the class type directly extended by this class, or null |
duke@1 | 64 | * if there is none |
duke@1 | 65 | */ |
duke@1 | 66 | ClassType getSuperclass(); |
duke@1 | 67 | |
duke@1 | 68 | /** |
duke@1 | 69 | * Returns the constructors of this class. |
duke@1 | 70 | * This includes the default constructor if this class has |
duke@1 | 71 | * no constructors explicitly declared. |
duke@1 | 72 | * |
duke@1 | 73 | * @return the constructors of this class |
duke@1 | 74 | * |
duke@1 | 75 | * @see com.sun.mirror.util.DeclarationFilter |
duke@1 | 76 | */ |
duke@1 | 77 | Collection<ConstructorDeclaration> getConstructors(); |
duke@1 | 78 | |
duke@1 | 79 | /** |
duke@1 | 80 | * {@inheritDoc} |
duke@1 | 81 | */ |
duke@1 | 82 | Collection<MethodDeclaration> getMethods(); |
duke@1 | 83 | } |