org.mozilla.javascript

Class NativeJavaPackage

Implemented Interfaces:
DebuggableObject, Scriptable, Serializable
Known Direct Subclasses:
NativeJavaTopPackage

public class NativeJavaPackage
extends ScriptableObject

This class reflects Java packages into the JavaScript environment. We lazily reflect classes and subpackages, and use a caching/sharing system to ensure that members reflected into one JavaPackage appear in all other references to the same package (as with Packages.java.lang and java.lang).
Author:
Mike Shaver
See Also:
NativeJavaArray, NativeJavaObject, NativeJavaClass

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

DONTENUM, EMPTY, PERMANENT, READONLY

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

NativeJavaPackage(String packageName)
Deprecated. NativeJavaPackage is an internal class, do not use it directly.
NativeJavaPackage(String packageName, ClassLoader classLoader)
Deprecated. NativeJavaPackage is an internal class, do not use it directly.

Method Summary

Object
get(String id, Scriptable start)
Get a named property from the object.
Object
get(int index, Scriptable start)
Get a property from the object selected by an integral index.
String
getClassName()
Get the name of the set of objects implemented by this Java class.
Object
getDefaultValue(Class ignored)
Get the default value of the object with a given hint.
boolean
has(String id, Scriptable start)
Indicates whether or not a named property is defined in an object.
boolean
has(int index, Scriptable start)
Indicates whether or not an indexed property is defined in an object.
void
put(String id, Scriptable start, Object value)
Sets a named property in this object.
void
put(int index, Scriptable start, Object value)
Sets an indexed property in this object.
String
toString()

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, get, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getFunctionPrototype, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isSealed, put, put, putProperty, putProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setParentScope, setPrototype

Constructor Details

NativeJavaPackage

public NativeJavaPackage(String packageName)

Deprecated. NativeJavaPackage is an internal class, do not use it directly.


NativeJavaPackage

public NativeJavaPackage(String packageName,
                         ClassLoader classLoader)

Deprecated. NativeJavaPackage is an internal class, do not use it directly.

Method Details

get

public Object get(String id,
                  Scriptable start)
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:
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 interface ScriptableObject
Parameters:
start - the object in which the lookup began
Returns:
the value of the property (may be null), or NOT_FOUND

get

public Object get(int index,
                  Scriptable start)
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 interface ScriptableObject
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

getClassName

public String getClassName()
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 interface ScriptableObject

getDefaultValue

public Object getDefaultValue(Class ignored)
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 interface ScriptableObject
Parameters:
Returns:
the default value

has

public boolean has(String id,
                   Scriptable start)
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 interface ScriptableObject
Parameters:
start - the object in which the lookup began
Returns:
true if and only if the named property is found in the object
See Also:
org.mozilla.javascript.Scriptable.get, org.mozilla.javascript.ScriptableObject.getProperty

has

public boolean has(int index,
                   Scriptable start)
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 interface ScriptableObject
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:
org.mozilla.javascript.Scriptable.get, org.mozilla.javascript.ScriptableObject.getProperty

put

public void put(String id,
                Scriptable start,
                Object value)
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 interface ScriptableObject
Parameters:
start - the object whose property is being set
value - value to set the property to
See Also:
org.mozilla.javascript.Scriptable.has, org.mozilla.javascript.Scriptable.get, org.mozilla.javascript.ScriptableObject.putProperty, org.mozilla.javascript.Context.toObject

put

public void put(int index,
                Scriptable start,
                Object value)
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 interface ScriptableObject
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:
org.mozilla.javascript.Scriptable.has, org.mozilla.javascript.Scriptable.get, Scriptable.put(String,Scriptable,Object), org.mozilla.javascript.ScriptableObject.putProperty

toString

public String toString()