Save This Page
Home » bsf-src-2.4.0 » org.apache.bsf.debug.meta » [javadoc | source]
org.apache.bsf.debug.meta
public class: JsObjectStub [javadoc | source]
java.lang.Object
   org.apache.bsf.debug.util.Stub
      org.apache.bsf.debug.meta.JsObjectStub

All Implemented Interfaces:
    JsObject, RemoteService

Direct Known Subclasses:
    JsCodeStub

Fields inherited from org.apache.bsf.debug.util.Stub:
UNDEFINED,  NOT_FOUND,  m_tid,  m_uid,  m_revoked,  m_con
Constructor:
 public JsObjectStub(SocketConnection con,
    int tid,
    int uid) 
Method from org.apache.bsf.debug.meta.JsObjectStub Summary:
define,   delete,   delete,   get,   get,   getClassName,   getDefaultValue,   getIds,   getPrototype,   getScope,   has,   has,   hasInstance,   isA,   isFunction,   isNotFound,   isScript,   isUndefined,   put,   put,   setPrototype,   setScope
Methods from org.apache.bsf.debug.util.Stub:
Init,   addListener,   completeFuture,   createFuture,   equals,   getConnection,   getTid,   getUid,   removeListener,   revokeFuture,   revoked,   suspendFuture,   swizzle
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.bsf.debug.meta.JsObjectStub Detail:
 public  void define(String propertyName,
    Object value,
    int attributes) throws RemoteException 
    The value can be any of the following type: java.lang.Boolean java.lang.Number java.lang.String org.apache.bsf.debug.jsdi.JsObject
 public  void delete(int index) throws RemoteException 
    Removes a property from this object. The prototype chain is not walked to find the property. This operation corresponds to the ECMA [[Delete]] except that the no result is returned. The runtime will guarantee that this method is called only if the property exists. After this method is called, the runtime will call Scriptable.has to see if the property has been removed in order to determine the boolean result of the delete operator as defined by ECMA 11.4.1.

    A property can be made permanent by ignoring calls to remove it. The property is specified by an integral index as defined for get.

    To delete properties defined in a prototype chain, first find the owner object of the property and then call deleteProperty on that owner object. Identical to delete(String) except that an integral index is used to select the property.

 public  void delete(String name) throws RemoteException 
    Removes a property from this object. This operation corresponds to the ECMA [[Delete]] except that the no result is returned. The runtime will guarantee that this method is called only if the property exists. After this method is called, the runtime will call Scriptable.has to see if the property has been removed in order to determine the boolean result of the delete operator as defined by ECMA 11.4.1.

    A property can be made permanent by ignoring calls to remove it.

    The property is specified by a String name as defined for get.

    To delete properties defined in a prototype chain, first find the owner object of the property and then call deleteProperty on that owner object.

 public Object get(String name) throws RemoteException 
    Get a named property from the object. Does not walk the prototype chain. Looks property up in this object and returns the associated value if found. Returns NOT_FOUND if not found. Note that this method is not expected to traverse the prototype chain. This is different from the ECMA [[Get]] operation. Depending on the property selector, the runtime will call this method or the form of get that takes an integer:
    JavaScript codeJava code
    a.b a.get("b", a)
    a["foo"] a.get("foo", a)
    a[3] a.get(3, a)
    a["3"] a.get(3, a)
    a[3.0] a.get(3, a)
    a["3.0"] a.get("3.0", a)
    a[1.1] a.get("1.1", a)
    a[-4] a.get(-4, a)

    The values that may be returned are limited to the following:

    • java.lang.Boolean objects
    • java.lang.String objects
    • java.lang.Number objects
    • org.apache.bsf.debug.jsdi.JsObject objects
    • null
    • The value returned by Context.getUndefinedValue()
    • NOT_FOUND
 public Object get(int index) throws RemoteException 
 public String getClassName() throws RemoteException 
    Get the name of the set of objects implemented by this Java class. This corresponds to the [[Class]] operation in ECMA and is used by Object.prototype.toString() in ECMA.

    See ECMA 8.6.2 and 15.2.4.2.

 public Object getDefaultValue(Class hint) throws RemoteException 
    Get the default value of the object with a given hint. The hints are String.class for type String, Number.class for type Number, Scriptable.class for type Object, and Boolean.class for type Boolean.

    A hint of null means "no hint". See ECMA 8.6.2.6.

 public Object[] getIds(boolean all) throws RemoteException 
    Returns an array of property ids defined on this object. The prototype chain is not walked. However, modified properties that were prototype properties will be seen. The parameter indicates to enumerate the "DONTENUM" properties or not.

 public JsObject getPrototype() throws RemoteException 
    Get the prototype of the object.
 public JsObject getScope() throws RemoteException 
    The scope is for supporting two things. If the object is a function, the scope is the "execution" scope of the function. It will be used when calling the function to initialize the Context scope. If the object is not a function, the scope is used for the scope chain of execution context.
 public boolean has(int index) throws RemoteException 
    Indicates whether or not an indexed property is defined in an object. Does not traverse the prototype chain.

    The property is specified by an integral index as defined for the get method.

 public boolean has(String name) throws RemoteException 
    Indicates whether or not a named property is defined in an object. Does not traverse the prototype chain.

    The property is specified by a String name as defined for the get method.

 public boolean hasInstance(JsObject instance) throws RemoteException 
    The instanceof operator.

    The JavaScript code "lhs instanceof rhs" causes rhs.hasInstance(lhs) to be called.

    The return value is implementation dependent so that embedded host objects can return an appropriate value. See the JS 1.3 language documentation for more detail.

    This operator corresponds to the proposed EMCA [[HasInstance]] operator.

 public boolean isA(int cmd) throws RemoteException 
 public boolean isFunction() throws RemoteException 
 public boolean isNotFound() 
    True if this object represents the "NOT_FOUND" value for a code. This is potentially returned from get if the property is not found.
 public boolean isScript() throws RemoteException 
 public boolean isUndefined() 
    Value returned when a property is undefined.
 public  void put(int index,
    Object value) throws RemoteException 
    Sets an indexed property in this object.

    The property is specified by an integral index as defined for get.

 public  void put(String name,
    Object value) throws RemoteException 
    Sets a named property in this object.

    The property is specified by a string name as defined for get.

    Note that if a property a is defined in the prototype p of an object o, then evaluating o.a = 23 will cause set to be called on the prototype p with o as the start parameter. To preserve JavaScript semantics, it is the Scriptable object's responsibility to modify o.

    This design allows properties to be defined in prototypes and implemented in terms of getters and setters of Java values without consuming slots in each instance.

    The values that may be set are limited to the following:

    • java.lang.Boolean objects
    • java.lang.String objects
    • java.lang.Number objects
    • org.apache.bsf.debug.jsdi.JsObject
    • null
    • The value returned by Context.getUndefinedValue()

    IMPORTANT: JAVA OBJECTS. The wrapping is not yet supported.

 public  void setPrototype(JsObject prototype) throws RemoteException 
    Set the prototype of the object.
 public  void setScope(JsObject scope) throws RemoteException 
    Set the prototype of the object.