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-2000
022: * the Initial Developer. All Rights Reserved.
023: *
024: * Contributor(s):
025: * Igor Bukanov
026: * Ethan Hugg
027: * Terry Lucas
028: * Milen Nankov
029: *
030: * Alternatively, the contents of this file may be used under the terms of
031: * the GNU General Public License Version 2 or later (the "GPL"), in which
032: * case the provisions of the GPL are applicable instead of those above. If
033: * you wish to allow use of your version of this file only under the terms of
034: * the GPL and not to allow others to use your version of this file under the
035: * MPL, indicate your decision by deleting the provisions above and replacing
036: * them with the notice and other provisions required by the GPL. If you do
037: * not delete the provisions above, a recipient may use your version of this
038: * file under either the MPL or the GPL.
039: *
040: * ***** END LICENSE BLOCK ***** */
041:
042: package org.mozilla.javascript.xml;
043:
044: import org.mozilla.javascript.*;
045:
046: /**
047: * This Interface describes what all XML objects (XML, XMLList) should have in common.
048: *
049: */
050: public abstract class XMLObject extends IdScriptableObject {
051: public XMLObject() {
052: }
053:
054: public XMLObject(Scriptable scope, Scriptable prototype) {
055: super (scope, prototype);
056: }
057:
058: /**
059: * Implementation of ECMAScript [[Has]].
060: */
061: public abstract boolean ecmaHas(Context cx, Object id);
062:
063: /**
064: * Implementation of ECMAScript [[Get]].
065: */
066: public abstract Object ecmaGet(Context cx, Object id);
067:
068: /**
069: * Implementation of ECMAScript [[Put]].
070: */
071: public abstract void ecmaPut(Context cx, Object id, Object value);
072:
073: /**
074: * Implementation of ECMAScript [[Delete]].
075: */
076: public abstract boolean ecmaDelete(Context cx, Object id);
077:
078: /**
079: * Return an additional object to look for methods that runtime should
080: * consider during method search. Return null if no such object available.
081: */
082: public abstract Scriptable getExtraMethodSource(Context cx);
083:
084: /**
085: * Generic reference to implement x.@y, x..y etc.
086: */
087: public abstract Ref memberRef(Context cx, Object elem,
088: int memberTypeFlags);
089:
090: /**
091: * Generic reference to implement x::ns, x.@ns::y, x..@ns::y etc.
092: */
093: public abstract Ref memberRef(Context cx, Object namespace,
094: Object elem, int memberTypeFlags);
095:
096: /**
097: * Wrap this object into NativeWith to implement the with statement.
098: */
099: public abstract NativeWith enterWith(Scriptable scope);
100:
101: /**
102: * Wrap this object into NativeWith to implement the .() query.
103: */
104: public abstract NativeWith enterDotQuery(Scriptable scope);
105:
106: /**
107: * Custom <tt>+</tt> operator.
108: * Should return {@link Scriptable#NOT_FOUND} if this object does not have
109: * custom addition operator for the given value,
110: * or the result of the addition operation.
111: * <p>
112: * The default implementation returns {@link Scriptable#NOT_FOUND}
113: * to indicate no custom addition operation.
114: *
115: * @param cx the Context object associated with the current thread.
116: * @param thisIsLeft if true, the object should calculate this + value
117: * if false, the object should calculate value + this.
118: * @param value the second argument for addition operation.
119: */
120: public Object addValues(Context cx, boolean this IsLeft, Object value) {
121: return Scriptable.NOT_FOUND;
122: }
123:
124: }
|