| java.lang.Object oscript.data.Value oscript.data.Type oscript.data.Function
Function | public class Function extends Type (Code) | | A script function/constructor. Since native (and other) objects that
behave as a function can re-use some functionality (ie checking number
of args, type casting, etc., the stuff specific to a script function/
constructor is pushed out into a seperate class.
author: Rob Clark (rob@ti.com) |
Inner Class :final public static class FunctionData implements Externalizable | |
Constructor Summary | |
public | Function(Scope enclosingScope, Value superFxn, FunctionData fd) Class Constructor. |
Method Summary | |
public Value | bopCast(Value val) | public Value | callAsConstructor(StackFrame sf, MemberTable args) Call this object as a constructor. | public Value | callAsExtends(StackFrame sf, Scope scope, MemberTable args) Call this object as a parent class constructor. | public Value | callAsFunction(StackFrame sf, MemberTable args) Call this object as a function. | public String | castToString() Convert this object to a native java String value. | public static Value | extractJavadocComment(Vector specials, Value name, int[] argIds) | public static Value | extractJavadocComment(String str, Value name, Value[] argNames) | public static Value | extractJavadocCommentBody(String str, Value name, Value[] argNames) | public Value[] | getArgNames() Get the names of the arguments to the function, in order. | public Value | getComment() Get the comment block. | public Value | getMember(int id, boolean exception) Get a member of this object. | public int | getMinimumArgCount() Get the minimum number of args that should be passed to this function. | public Value | getName() Get the name of this function. | Value | getOverriden() If this function overrides a value, this method returns it. | final Value | getStaticMember(int id) Get a static member of this function object. | Value | getSuper() Get the function that this function extends, or null if
none. | protected Value | getTypeImpl() Get the type of this object. | protected Value | getTypeMember(Value obj, int id) Get a member of this type. | public boolean | isA(Value type) If this object is a type, determine if an instance of this type is
an instance of the specified type, ie. | protected void | populateMemberSet(Set s, boolean debugger) Derived classes that implement
Function.getMember should also
implement this. | protected void | populateTypeMemberSet(Set s, boolean debugger) Derived classes that implement
Function.getTypeMember should also
implement this. | public boolean | takesVarArgs() |
PARENT_TYPE_NAME | final public static String PARENT_TYPE_NAME(Code) | | |
TYPE | final public static Value TYPE(Code) | | The type object for an script function.
|
fd | final public FunctionData fd(Code) | | The shared function data... parameters that are shared by all instances
of the same function.
public for
StackFrame.evalNode |
Function | public Function(Scope enclosingScope, Value superFxn, FunctionData fd)(Code) | | Class Constructor. Construct an anonymous function.
Parameters: enclosingScope - the context the function was declared in Parameters: superFxn - the function this function extends, or null Parameters: fd - the shared function data, for all instances of this function |
extractJavadocComment | public static Value extractJavadocComment(Vector specials, Value name, int[] argIds)(Code) | | |
getArgNames | public Value[] getArgNames()(Code) | | Get the names of the arguments to the function, in order. If this
function takes a variable number of arguments, the last name in the
array is the "var-arg" variable, to which the array of all remaining
arguments are bound.
|
getComment | public Value getComment()(Code) | | Get the comment block. If there was a javadoc comment block preceding
the definition of this function in the src file, it can be accessed
with this method.
the function's comment, or null |
getMinimumArgCount | public int getMinimumArgCount()(Code) | | Get the minimum number of args that should be passed to this function.
If
Function.isVarArgs returns true , then it is possible
to pass more arguments to this function, otherwise, you should pass
exactly this number of args to the function.
minimum number of args to pass when calling this function See Also: Function.isVarArgs See Also: Function.getArgNames |
getName | public Value getName()(Code) | | Get the name of this function. An anonymous function will have the
name "anon".
the function's name |
getOverriden | Value getOverriden()(Code) | | If this function overrides a value, this method returns it. Otherwise
it returns null .
|
getStaticMember | final Value getStaticMember(int id)(Code) | | Get a static member of this function object.
|
getSuper | Value getSuper()(Code) | | Get the function that this function extends, or null if
none.
|
getTypeImpl | protected Value getTypeImpl()(Code) | | Get the type of this object. The returned type doesn't have to take
into account the possibility of a script type extending a built-in
type, since that is handled by
Function.getType .
the object's type |
getTypeMember | protected Value getTypeMember(Value obj, int id)(Code) | | Get a member of this type. This is used to interface to the java
method of having members be attributes of a type. Regular object-
script object's members are attributes of the object, but in the
case of java types (including built-in types), the members are
attributes of the type.
Parameters: obj - an object of this type Parameters: id - the id of the symbol that maps to the member a reference to the member, or null |
isA | public boolean isA(Value type)(Code) | | If this object is a type, determine if an instance of this type is
an instance of the specified type, ie. if this is type ,
or a subclass.
Parameters: type - the type to compare this type to true or false throws: PackagedScriptObjectException - (NoSuchMemberException) |
populateMemberSet | protected void populateMemberSet(Set s, boolean debugger)(Code) | | Derived classes that implement
Function.getMember should also
implement this.
Parameters: s - the set to populate Parameters: debugger - true if being used by debugger, inwhich case both public and private/protected field names should be returned See Also: Function.getMember |
populateTypeMemberSet | protected void populateTypeMemberSet(Set s, boolean debugger)(Code) | | Derived classes that implement
Function.getTypeMember should also
implement this.
Parameters: s - the set to populate Parameters: debugger - true if being used by debugger, inwhich case both public and private/protected field names should be returned See Also: Function.getTypeMember |
Methods inherited from oscript.data.Value | public static Value _getTypeMember(Value type, Value obj, int id)(Code)(Java Doc) public static void _populateTypeMemberSet(Value type, java.util.Set s, boolean d)(Code)(Java Doc) public Value bopBitwiseAnd(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopBitwiseAndR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopBitwiseOr(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopBitwiseOrR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopBitwiseXor(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopBitwiseXorR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopCast(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopCastR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopDivide(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopDivideR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopEquals(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopEqualsR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopGreaterThan(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopGreaterThanOrEquals(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopGreaterThanOrEqualsR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopGreaterThanR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopInstanceOf(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopInstanceOfR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLeftShift(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLeftShiftR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLessThan(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLessThanOrEquals(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLessThanOrEqualsR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLessThanR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLogicalAnd(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLogicalAndR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLogicalOr(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopLogicalOrR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopMinus(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopMinusR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopMultiply(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopMultiplyR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopNotEquals(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopNotEqualsR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopPlus(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopPlusR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopRemainder(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopRemainderR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopSignedRightShift(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopSignedRightShiftR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopUnsignedRightShift(Value val) throws PackagedScriptObjectException(Code)(Java Doc) public Value bopUnsignedRightShiftR(Value val, PackagedScriptObjectException e) throws PackagedScriptObjectException(Code)(Java Doc) public Value callAsConstructor(StackFrame sf, MemberTable args) throws PackagedScriptObjectException(Code)(Java Doc) final public Value callAsConstructor(Value[] args) throws PackagedScriptObjectException(Code)(Java Doc) final public Value callAsConstructor(StackFrame sf, Value[] args)(Code)(Java Doc) public Value callAsExtends(StackFrame sf, Scope scope, MemberTable args) throws PackagedScriptObjectException(Code)(Java Doc) final public Value callAsExtends(Scope scope, MemberTable args) throws PackagedScriptObjectException(Code)(Java Doc) final public Value callAsExtends(StackFrame sf, Scope scope, Value[] args)(Code)(Java Doc) public Value callAsFunction(StackFrame sf, MemberTable args) throws PackagedScriptObjectException(Code)(Java Doc) final public Value callAsFunction(Value[] args) throws PackagedScriptObjectException(Code)(Java Doc) final public Value callAsFunction(StackFrame sf, Value[] args)(Code)(Java Doc) public boolean castToBoolean() throws PackagedScriptObjectException(Code)(Java Doc) public long castToExactNumber() throws PackagedScriptObjectException(Code)(Java Doc) public double castToInexactNumber() throws PackagedScriptObjectException(Code)(Java Doc) public Object castToJavaObject() throws PackagedScriptObjectException(Code)(Java Doc) public String castToString() throws PackagedScriptObjectException(Code)(Java Doc) public Value elementAt(Value idx) throws PackagedScriptObjectException(Code)(Java Doc) public Value elementsAt(Value idx1, Value idx2) throws PackagedScriptObjectException(Code)(Java Doc) final public Value getMember(String name) throws PackagedScriptObjectException(Code)(Java Doc) public Value getMember(Value name) throws PackagedScriptObjectException(Code)(Java Doc) final public Value getMember(int id) throws PackagedScriptObjectException(Code)(Java Doc) final public Value getMember(String name, boolean exception) throws PackagedScriptObjectException(Code)(Java Doc) final public Value getMember(Value name, boolean exception) throws PackagedScriptObjectException(Code)(Java Doc) public Value getMember(int id, boolean exception) throws PackagedScriptObjectException(Code)(Java Doc) public Object getMonitor()(Code)(Java Doc) public Value getType()(Code)(Java Doc) abstract protected Value getTypeImpl()(Code)(Java Doc) protected Value getTypeMember(Value obj, int id)(Code)(Java Doc) final protected Value getTypeMember(Value obj, Value name)(Code)(Java Doc) public boolean isA(Value type)(Code)(Java Doc) public int length() throws PackagedScriptObjectException(Code)(Java Doc) public java.util.Set memberSet()(Code)(Java Doc) protected PackagedScriptObjectException noSuchMember(String member)(Code)(Java Doc) public void opAssign(Value val) throws PackagedScriptObjectException(Code)(Java Doc) protected void populateMemberSet(java.util.Set s, boolean debugger)(Code)(Java Doc) protected void populateTypeMemberSet(java.util.Set s, boolean debugger)(Code)(Java Doc) public void readExternal(java.io.ObjectInput in) throws ClassNotFoundException, java.io.IOException(Code)(Java Doc) public String toString()(Code)(Java Doc) public Value unhand()(Code)(Java Doc) public Value uopBitwiseNot() throws PackagedScriptObjectException(Code)(Java Doc) public Value uopDecrement() throws PackagedScriptObjectException(Code)(Java Doc) public Value uopIncrement() throws PackagedScriptObjectException(Code)(Java Doc) public Value uopLogicalNot() throws PackagedScriptObjectException(Code)(Java Doc) public Value uopMinus() throws PackagedScriptObjectException(Code)(Java Doc) public Value uopPlus() throws PackagedScriptObjectException(Code)(Java Doc) public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException(Code)(Java Doc)
|
|
|