001: /* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
002: *
003: * ***** BEGIN LICENSE BLOCK *****
004: * Version: MPL 1.1/GPL 2.0
005: *
006: * The contents of this file are subject to the Mozilla Public License Version
007: * 1.1 (the "License"); you may not use this file except in compliance with
008: * the License. You may obtain a copy of the License at
009: * http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the
014: * License.
015: *
016: * The Original Code is Rhino code, released
017: * May 6, 1999.
018: *
019: * The Initial Developer of the Original Code is
020: * Netscape Communications Corporation.
021: * Portions created by the Initial Developer are Copyright (C) 1997-1999
022: * the Initial Developer. All Rights Reserved.
023: *
024: * Contributor(s):
025: * Bob Jervis
026: *
027: * Alternatively, the contents of this file may be used under the terms of
028: * the GNU General Public License Version 2 or later (the "GPL"), in which
029: * case the provisions of the GPL are applicable instead of those above. If
030: * you wish to allow use of your version of this file only under the terms of
031: * the GPL and not to allow others to use your version of this file under the
032: * MPL, indicate your decision by deleting the provisions above and replacing
033: * them with the notice and other provisions required by the GPL. If you do
034: * not delete the provisions above, a recipient may use your version of this
035: * file under either the MPL or the GPL.
036: *
037: * ***** END LICENSE BLOCK ***** */
038:
039: // API class
040: package org.mozilla.javascript;
041:
042: public interface ConstProperties {
043: /**
044: * Sets a named const property in this object.
045: * <p>
046: * The property is specified by a string name
047: * as defined for <code>Scriptable.get</code>.
048: * <p>
049: * The possible values that may be passed in are as defined for
050: * <code>Scriptable.get</code>. A class that implements this method may choose
051: * to ignore calls to set certain properties, in which case those
052: * properties are effectively read-only.<p>
053: * For properties defined in a prototype chain,
054: * use <code>putProperty</code> in ScriptableObject. <p>
055: * Note that if a property <i>a</i> is defined in the prototype <i>p</i>
056: * of an object <i>o</i>, then evaluating <code>o.a = 23</code> will cause
057: * <code>set</code> to be called on the prototype <i>p</i> with
058: * <i>o</i> as the <i>start</i> parameter.
059: * To preserve JavaScript semantics, it is the Scriptable
060: * object's responsibility to modify <i>o</i>. <p>
061: * This design allows properties to be defined in prototypes and implemented
062: * in terms of getters and setters of Java values without consuming slots
063: * in each instance.<p>
064: * <p>
065: * The values that may be set are limited to the following:
066: * <UL>
067: * <LI>java.lang.Boolean objects</LI>
068: * <LI>java.lang.String objects</LI>
069: * <LI>java.lang.Number objects</LI>
070: * <LI>org.mozilla.javascript.Scriptable objects</LI>
071: * <LI>null</LI>
072: * <LI>The value returned by Context.getUndefinedValue()</LI>
073: * </UL><p>
074: * Arbitrary Java objects may be wrapped in a Scriptable by first calling
075: * <code>Context.toObject</code>. This allows the property of a JavaScript
076: * object to contain an arbitrary Java object as a value.<p>
077: * Note that <code>has</code> will be called by the runtime first before
078: * <code>set</code> is called to determine in which object the
079: * property is defined.
080: * Note that this method is not expected to traverse the prototype chain,
081: * which is different from the ECMA [[Put]] operation.
082: * @param name the name of the property
083: * @param start the object whose property is being set
084: * @param value value to set the property to
085: * @see org.mozilla.javascript.Scriptable#has(String, Scriptable)
086: * @see org.mozilla.javascript.Scriptable#get(String, Scriptable)
087: * @see org.mozilla.javascript.ScriptableObject#putProperty(Scriptable, String, Object)
088: * @see org.mozilla.javascript.Context#toObject(Object, Scriptable)
089: */
090: public void putConst(String name, Scriptable start, Object value);
091:
092: /**
093: * Reserves a definition spot for a const. This will set up a definition
094: * of the const property, but set its value to undefined. The semantics of
095: * the start parameter is the same as for putConst.
096: * @param name The name of the property.
097: * @param start The object whose property is being reserved.
098: */
099: public void defineConst(String name, Scriptable start);
100:
101: /**
102: * Returns true if the named property is defined as a const on this object.
103: * @param name
104: * @return true if the named property is defined as a const, false
105: * otherwise.
106: */
107: public boolean isConst(String name);
108: }
|