io.apigee.trireme.core.internal

Class AbstractIdObject<T extends AbstractIdObject>

java.lang.Object

org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.IdScriptableObject

io.apigee.trireme.core.internal.AbstractIdObject<T>

All Implemented Interfaces:

Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.IdFunctionCall, org.mozilla.javascript.Scriptable

Direct Known Subclasses:

AbstractProcess, Buffer.BufferImpl

public abstract class AbstractIdObject<T extends AbstractIdObject>
extends org.mozilla.javascript.IdScriptableObject

This class makes it easier to use Rhino's "IdFunctionObject" by maintaining a map between prototype method names and property names, so all the implementor has to do is implement them. IdFunctionObject is more efficient than using the @JSFunction and @JSGetter annotations because it does not use reflection. This class uses a set of static HashMaps, per Java class, to mape between function and property IDs and names. This is slightly less-efficient than the hand-rolled switches used in Rhino source code but it is very close.

To use a class, a subclass must:

• Create an instance of IdPropertyMap for the class. This should be static.
• Call "addMethod" on that object for every new method it supports, with a unique numeric id.
• Call "addProperty" on that object for every property, with a unique id.
• Override "defaultConstructor" to return a valid instance of the class.
• If the class has prototype functions, override "prototypeCall" to implement them based on the id.
• If the class has other functions that do not depend on "this," override "anonymousCall".
• If the class has properties, override "getInstanceIdValue" and "setInstanceIdValue".
• Call "exportAsClass" on initialization to register the constructor and all its properties in a JavaScript scope before using the class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	Id_constructor

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIdObject(IdPropertyMap map)

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	anonymousCall(int id, org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope, Object thisObj, Object[] args) Subclasses may override this method to implement a function that does not necessarily depend on the value of "this" in the current scope.
protected abstract T	defaultConstructor() Subclasses must override this function.
protected T	defaultConstructor(org.mozilla.javascript.Context cx, Object[] args) Subclasses who need arguments to their constructor may override this function.
Object	execIdCall(org.mozilla.javascript.IdFunctionObject f, org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope, org.mozilla.javascript.Scriptable thisObj, Object[] args)
org.mozilla.javascript.Function	exportAsClass(org.mozilla.javascript.Scriptable scope)
protected int	findInstanceIdInfo(String name)
protected int	findPrototypeId(String name)
String	getClassName()
protected String	getInstanceIdName(int id)
protected int	getMaxInstanceId()
protected void	initPrototypeId(int id)
protected Object	prototypeCall(int id, org.mozilla.javascript.Context cx, org.mozilla.javascript.Scriptable scope, Object[] args) Subclasses may override this method to implement a prototype function.

Methods inherited from class org.mozilla.javascript.IdScriptableObject

activatePrototypeMap, addIdFunctionProperty, defaultGet, defaultHas, defaultPut, defineOwnProperty, delete, exportAsJSClass, fillConstructorProperties, get, getAttributes, getInstanceIdValue, getOwnPropertyDescriptor, has, hasPrototypeMap, incompatibleCallError, initPrototypeConstructor, initPrototypeMethod, initPrototypeValue, instanceIdInfo, put, setAttributes, setInstanceIdAttributes, setInstanceIdValue

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, equivalentValues, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasInstance, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Id_constructor

protected static final int Id_constructor

See Also:

Constant Field Values

Constructor Detail

AbstractIdObject

protected AbstractIdObject(IdPropertyMap map)

Method Detail

prototypeCall

protected Object prototypeCall(int id,
                   org.mozilla.javascript.Context cx,
                   org.mozilla.javascript.Scriptable scope,
                   Object[] args)

Subclasses may override this method to implement a prototype function. Each function will be called on the object that corresponds to "this" in the current scope. In order for this function to work, the "IdPropertyMap" for this class must have an entry for "id" entered by calling "addMethod". Subclasses should call "super.prototypeCall()" with all the arguments for any ID that is invalid.

anonymousCall

protected Object anonymousCall(int id,
                   org.mozilla.javascript.Context cx,
                   org.mozilla.javascript.Scriptable scope,
                   Object thisObj,
                   Object[] args)

Subclasses may override this method to implement a function that does not necessarily depend on the value of "this" in the current scope. In order for this function to work, the "IdPropertyMap" for this class must have an entry for "id" entered by calling "addMethod". Subclasses should call "super.prototypeCall()" with all the arguments for any ID that is invalid.

defaultConstructor

protected T defaultConstructor(org.mozilla.javascript.Context cx,
                   Object[] args)

Subclasses who need arguments to their constructor may override this function. If they do, then they should override the no-args form of this function as well to throw an Error.

defaultConstructor

protected abstract T defaultConstructor()

Subclasses must override this function. It must return an instance of the implementation class. It will be used during class initalization as well as every time a new instance is created.

getClassName

public String getClassName()

Specified by:

getClassName in interface org.mozilla.javascript.Scriptable

Specified by:

getClassName in class org.mozilla.javascript.ScriptableObject

exportAsClass

public org.mozilla.javascript.Function exportAsClass(org.mozilla.javascript.Scriptable scope)

getInstanceIdName

protected String getInstanceIdName(int id)

Overrides:

getInstanceIdName in class org.mozilla.javascript.IdScriptableObject

findInstanceIdInfo

protected int findInstanceIdInfo(String name)

Overrides:

findInstanceIdInfo in class org.mozilla.javascript.IdScriptableObject

getMaxInstanceId

protected int getMaxInstanceId()

Overrides:

getMaxInstanceId in class org.mozilla.javascript.IdScriptableObject

initPrototypeId

protected void initPrototypeId(int id)

Overrides:

initPrototypeId in class org.mozilla.javascript.IdScriptableObject

findPrototypeId

protected int findPrototypeId(String name)

Overrides:

findPrototypeId in class org.mozilla.javascript.IdScriptableObject

execIdCall

public Object execIdCall(org.mozilla.javascript.IdFunctionObject f,
                org.mozilla.javascript.Context cx,
                org.mozilla.javascript.Scriptable scope,
                org.mozilla.javascript.Scriptable thisObj,
                Object[] args)

Specified by:

execIdCall in interface org.mozilla.javascript.IdFunctionCall

Overrides:

execIdCall in class org.mozilla.javascript.IdScriptableObject