001    /*
002     * Copyright 2004 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.mirror.declaration;
027    
028    
029    import java.util.Collection;
030    
031    import com.sun.mirror.type.ClassType;
032    
033    
034    /**
035     * Represents the declaration of a class.
036     * For the declaration of an interface, see {@link InterfaceDeclaration}.
037     * Provides access to information about the class, its members, and
038     * its constructors.
039     * Note that an {@linkplain EnumDeclaration enum} is a kind of class.
040     *
041     * <p> While a <tt>ClassDeclaration</tt> represents the <i>declaration</i>
042     * of a class, a {@link ClassType} represents a class <i>type</i>.
043     * See {@link TypeDeclaration} for more on this distinction.
044     *
045     * <p> {@link com.sun.mirror.util.DeclarationFilter}
046     * provides a simple way to select just the items of interest
047     * when a method returns a collection of declarations.
048     *
049     * @author Joseph D. Darcy
050     * @author Scott Seligman
051     *
052     * @see ClassType
053     * @since 1.5
054     */
055    
056    public interface ClassDeclaration extends TypeDeclaration {
057    
058        /**
059         * Returns the class type directly extended by this class.
060         * The only class with no superclass is <tt>java.lang.Object</tt>,
061         * for which this method returns null.
062         *
063         * @return the class type directly extended by this class, or null
064         * if there is none
065         */
066        ClassType getSuperclass();
067    
068        /**
069         * Returns the constructors of this class.
070         * This includes the default constructor if this class has
071         * no constructors explicitly declared.
072         *
073         * @return the constructors of this class
074         *
075         * @see com.sun.mirror.util.DeclarationFilter
076         */
077        Collection<ConstructorDeclaration> getConstructors();
078    
079        /**
080         * {@inheritDoc}
081         */
082        Collection<MethodDeclaration> getMethods();
083    }