flash.tools.debugger.expression

Interface Context

All Known Implementing Classes:

ExpressionContext

public interface Context

An object which returns a value given a name and appropriate context information.

Method Summary

Methods

Modifier and Type	Method and Description
void	assign(Object o, Value v) Assign the object o, the value v.
Context	createContext(Object o) Creates a new context object by combining the current one and o.
void	createPseudoVariables(boolean oui) Enables/disables the creation of variables during lookup calls.
int	getIsolateId() The worker id to which this context object belongs.
Session	getSession() Returns the session associated with this context, or null.
Object	lookup(Object o) Looks for an object of the given name in this context -- for example, a member variable.
Object	lookupMembers(Object o) Looks for the members of an object.
Value	toValue() Converts the context to a Value.
Value	toValue(Object o) Converts the object to a Value.

Method Detail

lookup

Object lookup(Object o)
              throws NoSuchVariableException,
                     PlayerFaultException

Looks for an object of the given name in this context -- for example, a member variable. The returned Object can be of any type at all. For example, it could be:

• a flash.tools.debugger.Variable
• your own wrapper around Variable
• a flash.tools.debugger.Value
• any built-in Java primitive such as Long, Integer, Double, Boolean, or String
• any other type you want which has a good toString(); see below

Since the return type is just Object, the returned value is only meaningful when passed to other functions this interface. For example, the returned Object can be passed to createContext(), assign(), or toValue().

Parameters:

o - the object to look up; most commonly a string representing the name of a member variable.

Throws:

NoSuchVariableException

PlayerFaultException

lookupMembers

Object lookupMembers(Object o)
                     throws NoSuchVariableException

Looks for the members of an object.

Parameters:

o - A variable whose members we want to look up

Returns:

Some object which represents the members; could even be just a string. See lookup() for more information about the returned type.

Throws:

NoSuchVariableException

See Also:

lookup(Object)

createContext

Context createContext(Object o)

Creates a new context object by combining the current one and o. For example, if the user typed "myVariable.myMember", then this function will get called with o equal to the object which represents "myVariable". This function should return a new context which, when called with lookup("myMember"), will return an object for that member.

Parameters:

o - any object which may have been returned by this class's lookup() function

assign

void assign(Object o,
          Value v)
            throws NoSuchVariableException,
                   PlayerFaultException

Assign the object o, the value v.

Parameters:

o - a variable to assign to -- this should be some value returned by an earlier call to lookup().

v - a value, such as a Boolean, Long, String, etc.

Throws:

NoSuchVariableException

PlayerFaultException

createPseudoVariables

void createPseudoVariables(boolean oui)

Enables/disables the creation of variables during lookup calls. This is ONLY used by AssignmentExp for creating a assigning a value to a property which currently does not exist.

toValue

Value toValue(Object o)

Converts the object to a Value.

Parameters:

o - Either object that was returned by an earlier call to lookup(), or one of the raw types that can be returned by Value.getValueAsObject().

Returns:

the corresponding Value, or null.

See Also:

Value.getValueAsObject()

toValue

Value toValue()

Converts the context to a Value. Very similar to toValue(Object o), except that the object being converted is the object that was used to initialize this context.

Returns:

the corresponding Value, or null.

getSession

Session getSession()

Returns the session associated with this context, or null. This can legitimately be null; for example, in fdb, you are allowed to do things like "set $columnwidth = 120" before beginning a debugging session.

getIsolateId

int getIsolateId()

The worker id to which this context object belongs.