nashorn/src/jdk.scripting.nashorn/share/classes/jdk/nashorn/api/tree/CompilationUnitTree.java
author alanb
Fri, 08 Jan 2016 11:46:46 +0000
changeset 34903 0a5536ef0eec
parent 29407 3fd4ede1581e
child 35325 7624a7d7e661
permissions -rw-r--r--
8049422: Remove @jdk.Exported Reviewed-by: dfuchs, mchung, darcy, chegar
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29407
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     1
/*
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
     2
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
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
/**
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    31
 * Represents the abstract syntax tree for compilation units (source
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    32
 * files)
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    33
 *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    34
 * @since 1.9
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    35
 */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    36
public interface CompilationUnitTree extends Tree {
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    37
    /**
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    38
     * Return the list of source elements in this compilation unit.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    39
     *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    40
     * @return the list of source elements in this compilation unit
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    41
     */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    42
    List<? extends Tree> getSourceElements();
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    43
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    44
    /**
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    45
     * Return the source name of this script compilation unit.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    46
     *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    47
     * @return the source name of this script compilation unit
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    48
     */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    49
    String getSourceName();
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    50
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    51
    /**
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    52
     * Returns if this is a ECMAScript "strict" compilation unit or not.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    53
     *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    54
     * @return true if this compilation unit is declared "strict"
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    55
     */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    56
    boolean isStrict();
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 line map for this compilation unit, if available.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    60
     * Returns null if the line map is not available.
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    61
     *
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    62
     * @return the line map for this compilation unit
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    63
     */
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    64
    LineMap getLineMap();
3fd4ede1581e 8074671: Nashorn Parser API
sundar
parents:
diff changeset
    65
}