src/jdk.compiler/share/classes/com/sun/source/tree/PackageTree.java
author jlahoda
Wed, 02 Oct 2019 10:59:40 +0200
branchJDK-8226585-branch
changeset 58440 4c8a6d1d066c
parent 54817 ef73702a906e
permissions -rw-r--r--
Improving appearance of javadoc of the APIs associated with preview features.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     1
/*
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     2
 * Copyright (c) 2014, Oracle and/or its affiliates. All rights reserved.
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     4
 *
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    10
 *
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    15
 * accompanied this code).
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    16
 *
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    20
 *
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    23
 * questions.
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    24
 */
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    25
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    26
package com.sun.source.tree;
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    27
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    28
import java.util.List;
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    29
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    30
/**
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    31
 * Represents the package declaration.
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    32
 *
54817
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    33
 * @jls 7.3 Compilation Units
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    34
 * @jls 7.4 Package Declarations
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    35
 *
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    36
 * @author Paul Govereau
34912
954fa9df99c7 8146572: Update "@since 1.9" to "@since 9" to match java.version.specification [langtools]
jjg
parents: 25874
diff changeset
    37
 * @since 9
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    38
 */
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    39
public interface PackageTree extends Tree {
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    40
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    41
     * Returns the annotations associated with this package declaration.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    42
     * @return the annotations
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    43
     */
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    44
    List<? extends AnnotationTree> getAnnotations();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    45
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    46
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    47
     * Returns the name of the package being declared.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    48
     * @return the name
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 24069
diff changeset
    49
     */
24069
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    50
    ExpressionTree getPackageName();
dfb8f11542fc 8034245: Refactor TopLevel tree node.
pgovereau
parents:
diff changeset
    51
}