src/jdk.compiler/share/classes/com/sun/source/tree/NewClassTree.java
author jjg
Fri, 10 May 2019 13:37:00 -0700
changeset 54817 ef73702a906e
parent 47216 71c04702a3d5
permissions -rw-r--r--
8223654: Clean up @jls references in com.sun.source Reviewed-by: darcy
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
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * A tree node to declare a new instance of a class.
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 * For example:
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * <pre>
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 *   new <em>identifier</em> ( )
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 *   new <em>identifier</em> ( <em>arguments</em> )
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 *   new <em>typeArguments</em> <em>identifier</em> ( <em>arguments</em> )
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 *       <em>classBody</em>
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 *   <em>enclosingExpression</em>.new <em>identifier</em> ( <em>arguments</em> )
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 15.9 Class Instance Creation Expressions
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
 * @author Peter von der Ah&eacute;
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 * @author Jonathan Gibbons
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
public interface NewClassTree extends ExpressionTree {
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    52
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    53
     * Returns the enclosing expression, or {@code null} if none.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    54
     * @return the enclosing expression
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    55
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
    ExpressionTree getEnclosingExpression();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    57
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    58
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    59
     * Returns the type arguments for the object being created.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    60
     * @return the type arguments
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    61
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    62
    List<? extends Tree> getTypeArguments();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    63
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    64
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    65
     * Returns the name of the class being instantiated.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    66
     * @return the name
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    67
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
    ExpressionTree getIdentifier();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    69
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    70
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    71
     * Returns the arguments for the constructor to be invoked.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    72
     * @return the arguments
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    73
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    74
    List<? extends ExpressionTree> getArguments();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    75
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    76
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    77
     * Returns the class body if an anonymous class is being
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    78
     * instantiated, and {@code null} otherwise.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    79
     * @return the class body
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    80
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
    ClassTree getClassBody();
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
}