src/jdk.compiler/share/classes/com/sun/source/tree/ClassTree.java
author phh
Sat, 30 Nov 2019 14:33:05 -0800
changeset 59330 5b96c12f909d
parent 54817 ef73702a906e
permissions -rw-r--r--
8234541: C1 emits an empty message when it inlines successfully Summary: Use "inline" as the message when successfull Reviewed-by: thartmann, mdoerr Contributed-by: navy.xliu@gmail.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
     2
 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.source.tree;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
import java.util.List;
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import javax.lang.model.element.Name;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * A tree node for a class, interface, enum, or annotation
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * type declaration.
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 * For example:
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * <pre>
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 *   <em>modifiers</em> class <em>simpleName</em> <em>typeParameters</em>
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 *       extends <em>extendsClause</em>
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 *       implements <em>implementsClause</em>
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 *   {
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 *       <em>members</em>
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 *   }
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * </pre>
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 *
54817
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    45
 * @jls 8.1 Class Declarations
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    46
 * @jls 8.9 Enum Types
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    47
 * @jls 9.1 Interface Declarations
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    48
 * @jls 9.6 Annotation Types
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 * @author Peter von der Ah&eacute;
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
 * @author Jonathan Gibbons
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
public interface ClassTree extends StatementTree {
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    55
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    56
     * Returns the modifiers, including any annotations,
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    57
     * for this type declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    58
     * @return the modifiers
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    59
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    60
    ModifiersTree getModifiers();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    61
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    62
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    63
     * Returns the simple name of this type declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    64
     * @return the simple name
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    65
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
    Name getSimpleName();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    67
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    68
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    69
     * Returns any type parameters of this type declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    70
     * @return the type parameters
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    71
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    72
    List<? extends TypeParameterTree> getTypeParameters();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    73
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    74
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    75
     * Returns the supertype of this type declaration,
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    76
     * or {@code null} if none is provided.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    77
     * @return the supertype
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    78
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
    Tree getExtendsClause();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    80
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    81
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    82
     * Returns the interfaces implemented by this type declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    83
     * @return the interfaces
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    84
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    List<? extends Tree> getImplementsClause();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    86
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    87
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    88
     * Returns the members declared in this type declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    89
     * @return the members
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    90
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    List<? extends Tree> getMembers();
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
}