ClassTree.java revision 2571:10fc81ac75b4 
1/*
2 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package com.sun.source.tree;
27
28import java.util.List;
29import javax.lang.model.element.Name;
30
31/**
32 * A tree node for a class, interface, enum, or annotation
33 * type declaration.
34 *
35 * For example:
36 * <pre>
37 *   <em>modifiers</em> class <em>simpleName</em> <em>typeParameters</em>
38 *       extends <em>extendsClause</em>
39 *       implements <em>implementsClause</em>
40 *   {
41 *       <em>members</em>
42 *   }
43 * </pre>
44 *
45 * @jls sections 8.1, 8.9, 9.1, and 9.6
46 *
47 * @author Peter von der Ah&eacute;
48 * @author Jonathan Gibbons
49 * @since 1.6
50 */
51@jdk.Exported
52public interface ClassTree extends StatementTree {
53    /**
54     * Returns the modifiers, including any annotations,
55     * for this type declaration.
56     * @return the modifiers
57     */
58    ModifiersTree getModifiers();
59
60    /**
61     * Returns the simple name of this type declaration.
62     * @return the simple name
63     */
64    Name getSimpleName();
65
66    /**
67     * Returns any type parameters of this type declaration.
68     * @return the type parameters
69     */
70    List<? extends TypeParameterTree> getTypeParameters();
71
72    /**
73     * Returns the supertype of this type declaration,
74     * or {@code null} if none is provided.
75     * @return the supertype
76     */
77    Tree getExtendsClause();
78
79    /**
80     * Returns the interfaces implemented by this type declaration.
81     * @return the interfaces
82     */
83    List<? extends Tree> getImplementsClause();
84
85    /**
86     * Returns the members declared in this type declaration.
87     * @return the members
88     */
89    List<? extends Tree> getMembers();
90}
91