src/jdk.compiler/share/classes/com/sun/source/tree/CompilationUnitTree.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: 24069
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.tools.JavaFileObject;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * Represents the abstract syntax tree for compilation units (source
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * files) and package declarations (package-info.java).
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 *
54817
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    35
 * @jls 7.3 Compilation Units
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    36
 * @jls 7.4 Package Declarations
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 * @author Peter von der Ahé
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
public interface CompilationUnitTree extends Tree {
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    42
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    43
     * Returns the annotations listed on any package declaration
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    44
     * at the head of this compilation unit, or {@code null} if there
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    45
     * is no package declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    46
     * @return the package annotations
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    47
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
    List<? extends AnnotationTree> getPackageAnnotations();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    49
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    50
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    51
     * Returns the name contained in any package declaration
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    52
     * at the head of this compilation unit, or {@code null} if there
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    53
     * is no package declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    54
     * @return the package name
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    55
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    ExpressionTree getPackageName();
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 20612
diff changeset
    57
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 20612
diff changeset
    58
    /**
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    59
     * Returns the package tree associated with this compilation unit,
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    60
     * or {@code null} if there is no package declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    61
     * @return the package tree
34912
954fa9df99c7 8146572: Update "@since 1.9" to "@since 9" to match java.version.specification [langtools]
jjg
parents: 25874
diff changeset
    62
     * @since 9
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 20612
diff changeset
    63
     */
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents: 20612
diff changeset
    64
    PackageTree getPackage();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    65
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    66
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    67
     * Returns the import declarations appearing in this compilation unit.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    68
     * @return the import declarations
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    69
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
    List<? extends ImportTree> getImports();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    71
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    72
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    73
     * Returns the type declarations appearing in this compilation unit.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    74
     * The list may also include empty statements resulting from
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    75
     * extraneous semicolons.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    76
     * @return the type declarations
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    77
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    78
    List<? extends Tree> getTypeDecls();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    79
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    80
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    81
     * Returns the file object containing the source for this compilation unit.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    82
     * @return the file object
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    83
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
    JavaFileObject getSourceFile();
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
    /**
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    87
     * Returns the line map for this compilation unit, if available.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    88
     * Returns {@code null} if the line map is not available.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
     * @return the line map for this compilation unit
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
    LineMap getLineMap();
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
}