1 /*
   2  * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.nashorn.api.tree;
  27 
  28 import java.util.List;
  29 
  30 /**
  31  * A tree node for a <a href="http://www.ecma-international.org/ecma-262/6.0/#sec-function-definitions">function declaration</a>.
  32  *
  33  * For example:
  34  * <pre>
  35  *   <em>function</em> <em>name</em>
  36  *      ( <em>parameters</em> )
  37  *      <em>body</em>
  38  * </pre>
  39  *
  40  * <pre>
  41  *   <em>function*</em> <em>name</em>
  42  *      ( <em>parameters</em> )
  43  *      <em>body</em>
  44  * </pre>
  45  *
  46  * @since 9
  47  */
  48 public interface FunctionDeclarationTree extends StatementTree {
  49     /**
  50      * Returns the name of the function being declared.
  51      *
  52      * @return name the function declared
  53      */
  54     IdentifierTree getName();
  55 
  56     /**
  57      * Returns the parameters of this function.
  58      *
  59      * @return the list of parameters
  60      */
  61     List<? extends ExpressionTree> getParameters();
  62 
  63     /**
  64      * Returns the body of code of this function.
  65      *
  66      * @return the body of code
  67      */
  68     BlockTree getBody();
  69 
  70     /**
  71      * Is this a strict function?
  72      *
  73      * @return true if this function is strict
  74      */
  75     boolean isStrict();
  76 
  77     /**
  78      * Is this a generator function?
  79      *
  80      * @return true if this is a generator function
  81      */
  82     boolean isGenerator();
  83 }