nashorn/src/jdk/nashorn/api/scripting/JSObject.java
author sundar
Mon, 24 Jun 2013 19:06:01 +0530
changeset 18614 addca7a10167
parent 17751 15a93d511eb7
child 19889 63af9358d0dc
permissions -rw-r--r--
8015959: Can't call foreign constructor Reviewed-by: jlaskey, hannesw
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     1
/*
16151
97c1e756ae1e 8005663: Update copyright year to 2013
jlaskey
parents: 16147
diff changeset
     2
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     4
 *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    10
 *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    15
 * accompanied this code).
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    16
 *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    20
 *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    23
 * questions.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    24
 */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    25
17751
15a93d511eb7 8009141: Avoid netscape.javascript.JSObject in nashorn code
sundar
parents: 16151
diff changeset
    26
package jdk.nashorn.api.scripting;
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    27
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    28
/**
17751
15a93d511eb7 8009141: Avoid netscape.javascript.JSObject in nashorn code
sundar
parents: 16151
diff changeset
    29
 * netscape.javascript.JSObject-like interface for nashorn script objects.
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    30
 */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    31
public abstract class JSObject {
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    32
    /**
18614
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    33
     * Call a JavaScript function
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    34
     *
18614
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    35
     * @param functionName name of function
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    36
     * @param args arguments to method
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    37
     * @return result of call
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    38
     */
18614
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    39
    public abstract Object call(String functionName, Object... args);
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    40
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    41
    /**
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    42
     * Call a JavaScript method as a constructor. This is equivalent to
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    43
     * calling new obj.Method(arg1, arg2...) in JavaScript.
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    44
     *
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    45
     * @param functionName name of function
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    46
     * @param args arguments to method
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    47
     * @return result of constructor call
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    48
     */
addca7a10167 8015959: Can't call foreign constructor
sundar
parents: 17751
diff changeset
    49
    public abstract Object newObject(String functionName, Object... args);
16147
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    50
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    51
    /**
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    52
     * Evaluate a JavaScript expression
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    53
     *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    54
     * @param s JavaScript expression to evaluate
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    55
     * @return evaluation result
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    56
     */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    57
    public abstract Object eval(String s);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    58
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    59
    /**
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    60
     * Retrieves a named member of a JavaScript object.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    61
     *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    62
     * @param name of member
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    63
     * @return member
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    64
     */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    65
    public abstract Object getMember(String name);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    66
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    67
    /**
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    68
     * Retrieves an indexed member of a JavaScript object.
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    69
     *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    70
     * @param index index of member slot
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    71
     * @return member
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    72
     */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    73
    public abstract Object getSlot(int index);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    74
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    75
    /**
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    76
     * Remove a named member from a JavaScript object
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    77
     *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    78
     * @param name name of member
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    79
     */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    80
    public abstract void removeMember(String name);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    81
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    82
    /**
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    83
     * Set a named member in a JavaScript object
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    84
     *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    85
     * @param name  name of member
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    86
     * @param value value of member
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    87
     */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    88
    public abstract void setMember(String name, Object value);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    89
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    90
    /**
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    91
     * Set an indexed member in a JavaScript object
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    92
     *
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    93
     * @param index index of member slot
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    94
     * @param value value of member
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    95
     */
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    96
    public abstract void setSlot(int index, Object value);
e63b63819133 8005403: Open-source Nashorn
jlaskey
parents:
diff changeset
    97
}