src/jdk.scripting.nashorn/share/classes/jdk/nashorn/api/tree/FunctionExpressionTree.java
author sundar
Thu, 28 Jun 2018 18:04:19 +0530
changeset 50878 fb7800b66c92
parent 47216 71c04702a3d5
permissions -rw-r--r--
8204492: Add deprecation annotation to Nashorn APIs and warning to nashorn, jjs Reviewed-by: jlaskey, hannesw
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     1
/*
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
     2
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     4
 *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    10
 *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    15
 * accompanied this code).
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    16
 *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    20
 *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    23
 * questions.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    24
 */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    25
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    26
package jdk.nashorn.api.tree;
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    27
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    28
import java.util.List;
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    29
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    30
/**
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    31
 * A tree node for <a href="http://www.ecma-international.org/ecma-262/6.0/#sec-function-defining-expressions">function expressions</a> including <a href="http://www.ecma-international.org/ecma-262/6.0/#sec-arrow-function-definitions">arrow functions</a>.
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    32
 *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    33
 * For example:
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    34
 * <pre>
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    35
 *   <em>var</em> func = <em>function</em>
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    36
 *      ( <em>parameters</em> )
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    37
 *      <em>body</em>
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    38
 * </pre>
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    39
 *
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    40
 * <pre>
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    41
 *   <em>var</em> func = <em>(x) =&gt; x+1</em>
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    42
 * </pre>
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    43
 *
50878
fb7800b66c92 8204492: Add deprecation annotation to Nashorn APIs and warning to nashorn, jjs
sundar
parents: 47216
diff changeset
    44
 * @deprecated Nashorn JavaScript script engine and APIs, and the jjs tool
fb7800b66c92 8204492: Add deprecation annotation to Nashorn APIs and warning to nashorn, jjs
sundar
parents: 47216
diff changeset
    45
 * are deprecated with the intent to remove them in a future release.
fb7800b66c92 8204492: Add deprecation annotation to Nashorn APIs and warning to nashorn, jjs
sundar
parents: 47216
diff changeset
    46
 *
35325
7624a7d7e661 8136494: Update "@since 1.9" to "@since 9" to match java.version.specification
iris
parents: 34903
diff changeset
    47
 * @since 9
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    48
 */
50878
fb7800b66c92 8204492: Add deprecation annotation to Nashorn APIs and warning to nashorn, jjs
sundar
parents: 47216
diff changeset
    49
@Deprecated(since="11", forRemoval=true)
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    50
public interface FunctionExpressionTree extends ExpressionTree {
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    51
    /**
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    52
     * Returns the name of the function being declared.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    53
     *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    54
     * @return name the function declared
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    55
     */
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    56
    IdentifierTree getName();
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    57
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    58
    /**
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    59
     * Returns the parameters of this function.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    60
     *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    61
     * @return the list of parameters
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    62
     */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    63
    List<? extends ExpressionTree> getParameters();
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    64
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    65
    /**
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    66
     * Returns the body of this function. This may be a {@link BlockTree} when this
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    67
     * function has a block body. This is an {@link ExpressionTree} when the function body
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    68
     * is a concise expression as in an expression arrow, or in an expression closure.
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    69
     *
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    70
     * @return the body of this function
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    71
     */
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    72
    Tree getBody();
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    73
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    74
    /**
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    75
     * Is this a strict function?
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    76
     *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    77
     * @return true if this function is strict
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    78
     */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    79
    boolean isStrict();
39662
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    80
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    81
    /**
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    82
     * Is this a arrow function?
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    83
     *
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    84
     * @return true if this is a arrow function
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    85
     */
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    86
    boolean isArrow();
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    87
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    88
    /**
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    89
     * Is this a generator function?
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    90
     *
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    91
     * @return true if this is a generator function
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    92
     */
e2b36a3779b9 8149929: Nashorn Parser API needs to be updated for ES6
sundar
parents: 35325
diff changeset
    93
    boolean isGenerator();
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    94
}