Package org.mozilla.javascript

Class NativeJavaArray

java.lang.Object
org.mozilla.javascript.NativeJavaObject
org.mozilla.javascript.NativeJavaArray
All Implemented Interfaces:
Serializable, Scriptable, SymbolScriptable, Wrapper
public class NativeJavaArray extends NativeJavaObject implements SymbolScriptable
This class reflects Java arrays into the JavaScript environment.
Author:
Mike Shaver
See Also:

  • Constructor Details

  • Method Details

    • getClassName

      public String getClassName()
      Description copied from interface: Scriptable
      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.

      Specified by:
      getClassName in interface Scriptable
      Overrides:
      getClassName in class NativeJavaObject

    • wrap

      public static NativeJavaArray wrap(Scriptable scope, Object array)

    • unwrap

      public Object unwrap()
      Description copied from interface: Wrapper
      Unwrap the object by returning the wrapped value.
      Specified by:
      unwrap in interface Wrapper
      Overrides:
      unwrap in class NativeJavaObject
      Returns:
      a wrapped value

    • has

      public boolean has(String id, Scriptable start)
      Description copied from interface: Scriptable
      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.

      Specified by:
      has in interface Scriptable
      Overrides:
      has in class NativeJavaObject
      Parameters:
      id - the name of the property
      start - the object in which the lookup began
      Returns:
      true if and only if the named property is found in the object
      See Also:

    • has

      public boolean has(int index, Scriptable start)
      Description copied from interface: Scriptable
      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.

      Specified by:
      has in interface Scriptable
      Overrides:
      has in class NativeJavaObject
      Parameters:
      index - the numeric index for the property
      start - the object in which the lookup began
      Returns:
      true if and only if the indexed property is found in the object
      See Also:

    • has

      public boolean has(Symbol key, Scriptable start)
      Description copied from interface: SymbolScriptable
      Return true if the specified property exists.
      Specified by:
      has in interface SymbolScriptable
      Overrides:
      has in class NativeJavaObject

    • get

      public Object get(String id, Scriptable start)
      Description copied from interface: Scriptable
      Get a named property from the object.

      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:

      Code examples
      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.mozilla.javascript.Scriptable objects
      • null
      • The value returned by Context.getUndefinedValue()
      • NOT_FOUND
      Specified by:
      get in interface Scriptable
      Overrides:
      get in class NativeJavaObject
      Parameters:
      id - the name of the property
      start - the object in which the lookup began
      Returns:
      the value of the property (may be null), or NOT_FOUND
      See Also:

    • get

      public Object get(int index, Scriptable start)
      Description copied from interface: Scriptable
      Get a property from the object selected by an integral index.

      Identical to get(String, Scriptable) except that an integral index is used to select the property.

      Specified by:
      get in interface Scriptable
      Overrides:
      get in class NativeJavaObject
      Parameters:
      index - the numeric index for the property
      start - the object in which the lookup began
      Returns:
      the value of the property (may be null), or NOT_FOUND
      See Also:

    • get

      public Object get(Symbol key, Scriptable start)
      Description copied from interface: SymbolScriptable
      Return the value of the property with the specified key, or NOT_FOUND.
      Specified by:
      get in interface SymbolScriptable
      Overrides:
      get in class NativeJavaObject

    • put

      public void put(String id, Scriptable start, Object value)
      Description copied from interface: Scriptable
      Sets a named property in this object.

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

      The possible values that may be passed in are as defined for get. A class that implements this method may choose to ignore calls to set certain properties, in which case those properties are effectively read-only.

      For properties defined in a prototype chain, use putProperty in ScriptableObject.

      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.mozilla.javascript.Scriptable objects
      • null
      • The value returned by Context.getUndefinedValue()

      Arbitrary Java objects may be wrapped in a Scriptable by first calling Context.toObject. This allows the property of a JavaScript object to contain an arbitrary Java object as a value.

      Note that has will be called by the runtime first before set is called to determine in which object the property is defined. Note that this method is not expected to traverse the prototype chain, which is different from the ECMA [[Put]] operation.

      Specified by:
      put in interface Scriptable
      Overrides:
      put in class NativeJavaObject
      Parameters:
      id - the name of the property
      start - the object whose property is being set
      value - value to set the property to
      See Also:

    • put

      public void put(int index, Scriptable start, Object value)
      Description copied from interface: Scriptable
      Sets an indexed property in this object.

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

      Identical to put(String, Scriptable, Object) except that an integral index is used to select the property.

      Specified by:
      put in interface Scriptable
      Overrides:
      put in class NativeJavaObject
      Parameters:
      index - the numeric index for the property
      start - the object whose property is being set
      value - value to set the property to
      See Also:

    • delete

      public void delete(Symbol key)
      Description copied from interface: SymbolScriptable
      Delete a property with the specified key.
      Specified by:
      delete in interface SymbolScriptable
      Overrides:
      delete in class NativeJavaObject

    • getDefaultValue

      public Object getDefaultValue(Class<?> hint)
      Description copied from interface: Scriptable
      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.

      Specified by:
      getDefaultValue in interface Scriptable
      Overrides:
      getDefaultValue in class NativeJavaObject
      Parameters:
      hint - the type hint
      Returns:
      the default value

    • getIds

      public Object[] getIds()
      Description copied from interface: Scriptable
      Get an array of property ids.

      Not all property ids need be returned. Those properties whose ids are not returned are considered non-enumerable.

      Specified by:
      getIds in interface Scriptable
      Overrides:
      getIds in class NativeJavaObject
      Returns:
      an array of Objects. Each entry in the array is either a java.lang.String or a java.lang.Number

    • hasInstance

      public boolean hasInstance(Scriptable value)
      Description copied from interface: Scriptable
      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.

      Specified by:
      hasInstance in interface Scriptable
      Overrides:
      hasInstance in class NativeJavaObject
      Parameters:
      value - The value that appeared on the LHS of the instanceof operator
      Returns:
      an implementation dependent value

    • getPrototype

      public Scriptable getPrototype()
      Description copied from interface: Scriptable
      Get the prototype of the object.
      Specified by:
      getPrototype in interface Scriptable
      Overrides:
      getPrototype in class NativeJavaObject
      Returns:
      the prototype

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class NativeJavaObject

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class NativeJavaObject