01: /*
02: * @(#)ClassDeclaration.java 1.3 04/02/20
03: *
04: * Copyright (c) 2004, Sun Microsystems, Inc.
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions are met:
09: *
10: * * Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * * Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in the
14: * documentation and/or other materials provided with the distribution.
15: * * Neither the name of the Sun Microsystems, Inc. nor the names of
16: * its contributors may be used to endorse or promote products derived from
17: * this software without specific prior written permission.
18: *
19: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
20: * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21: * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
23: * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30: */
31:
32: package com.sun.mirror.declaration;
33:
34: import java.util.Collection;
35:
36: import com.sun.mirror.type.ClassType;
37:
38: /**
39: * Represents the declaration of a class.
40: * For the declaration of an interface, see {@link InterfaceDeclaration}.
41: * Provides access to information about the class, its members, and
42: * its constructors.
43: * Note that an {@linkplain EnumDeclaration enum} is a kind of class.
44: *
45: * <p> While a <tt>ClassDeclaration</tt> represents the <i>declaration</i>
46: * of a class, a {@link ClassType} represents a class <i>type</i>.
47: * See {@link TypeDeclaration} for more on this distinction.
48: *
49: * <p> {@link com.sun.mirror.util.DeclarationFilter}
50: * provides a simple way to select just the items of interest
51: * when a method returns a collection of declarations.
52: *
53: * @author Joseph D. Darcy
54: * @author Scott Seligman
55: * @version 1.3 04/02/20
56: *
57: * @see ClassType
58: * @since 1.5
59: */
60:
61: public interface ClassDeclaration extends TypeDeclaration {
62:
63: /**
64: * Returns the class type directly extended by this class.
65: * The only class with no superclass is <tt>java.lang.Object</tt>,
66: * for which this method returns null.
67: *
68: * @return the class type directly extended by this class, or null
69: * if there is none
70: */
71: ClassType getSuperclass();
72:
73: /**
74: * Returns the constructors of this class.
75: * This includes the default constructor if this class has
76: * no constructors explicitly declared.
77: *
78: * @return the constructors of this class
79: *
80: * @see com.sun.mirror.util.DeclarationFilter
81: */
82: Collection<ConstructorDeclaration> getConstructors();
83:
84: /**
85: * {@inheritDoc}
86: */
87: Collection<MethodDeclaration> getMethods();
88: }
|