flash.tools.debugger

Interface Variable

All Known Implementing Classes:

DVariable, ThreadSafeVariable, VariableFacade

public interface Variable

A Variable is any ActionScript variable, such as a String, Number, etc. It encapsulates the concept of a type and a value.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAttributes() Variable attributes define further information regarding the variable.
String	getDefiningClass() The class in which this member was actually defined.
int	getIsolateId() Get the worker id of the isolate to which this value belongs.
int	getLevel() For a member variable of an instance of some class, its "level" indicates how far up the class hierarchy it is from the actual class of the instance.
String	getName() The name of the variable.
String	getNamespace() The namespace of the variable.
String	getQualifiedName() The fully qualified name of the variable, i.e.
int	getScope() Returns just the scope bits of the attributes.
Value	getValue() Returns the value of the variable.
boolean	hasValueChanged(Session s) Returns whether the value of the variable has changed since the last time the program was suspended.
void	invokeGetter(Session s) Executes the getter for this variable, and changes its value accordingly.
boolean	isAttributeSet(int variableAttribute)
boolean	needsToInvokeGetter()
FaultEvent	setValue(Session s, int type, String value) Changes the value of a variable.

Method Detail

getName

String getName()

The name of the variable.

getQualifiedName

String getQualifiedName()

The fully qualified name of the variable, i.e. "namespace::name" if there is a namespace, or just "name" if not.

getNamespace

String getNamespace()

The namespace of the variable. This is everything before the "::". For example:

• If a variable was declared "private var x", then the namespace is "ClassName$3", where "3" might be any number.
• If a variable was declared within a namespace, e.g. "mynamespace var x", then the namespace might be "http://blahblah::x", where "http://blahblah" is the URL of the namespace.
• If a variable was declared neither public nor private (and is therefore "internal"), and it is inside of a package, then the namespace might be "packagename".

Returns:

namespace or "", never null

getScope

int getScope()

Returns just the scope bits of the attributes. The scope values from VariableAttribute (PUBLIC_SCOPE etc.) are NOT bitfields, so the returned value can be compared directly to VariableAttribute.PUBLIC_SCOPE, etc. using "==".

See Also:

VariableAttribute

getLevel

int getLevel()

For a member variable of an instance of some class, its "level" indicates how far up the class hierarchy it is from the actual class of the instance. For example, suppose you have this code:

    class A           { int a }
    class B extends A { int b }
    class C extends B { int c }
    var myObject: C
 

In this case, for myObject, the "level" of variable c is 0; the level of b is 1; and the level of a is 2.

getDefiningClass

String getDefiningClass()

The class in which this member was actually defined. For example, if class B extends class A, and class A has member variable V, then for variable V, the defining class is always "A", even though the parent variable might be an instance of class B.

getAttributes

int getAttributes()

Variable attributes define further information regarding the variable. They are bitfields identified as VariableAttribute.xxx

See Also:

VariableAttribute

isAttributeSet

boolean isAttributeSet(int variableAttribute)

See Also:

VariableAttribute

getValue

Value getValue()

Returns the value of the variable.

hasValueChanged

boolean hasValueChanged(Session s)

Returns whether the value of the variable has changed since the last time the program was suspended. If the previous value of the variable is unknown, this function will return false.

setValue

FaultEvent setValue(Session s,
                  int type,
                  String value)
                    throws NotSuspendedException,
                           NoResponseException,
                           NotConnectedException

Changes the value of a variable. New members cannot be added to a Variable, only the value of existing scalar members can be modified.

Parameters:

type - the type of the member which is being set. Use VariableType.UNDEFINED in order to set the variable to an undefined state; the contents of 'value' will be ignored.

value - the string value of the member. May be 'true' or 'false' for Boolean types or any valid number for Number types.

Returns:

null, if set was successful; or a FaultEvent if a setter was invoked and the setter threw an exception. In that case, look at FaultEvent.information to see the error text of the exception that occurred.

Throws:

NoResponseException - if times out

NotSuspendedException - if Player is running

NotConnectedException - if Player is disconnected from Session

needsToInvokeGetter

boolean needsToInvokeGetter()

Returns:

True if this variable has a getter, and the getter has not yet been invoked.

invokeGetter

void invokeGetter(Session s)
                  throws NotSuspendedException,
                         NoResponseException,
                         NotConnectedException

Executes the getter for this variable, and changes its value accordingly. Note that the HAS_GETTER flag is not affected by this call -- even after this call, HAS_GETTER will still be true. If you want to test whether the getter has already been executed, call needsToInvokeGetter().

Has no effect if needsToInvokeGetter() is false.

Throws:

NotSuspendedException

NoResponseException

NotConnectedException

getIsolateId

int getIsolateId()

Get the worker id of the isolate to which this value belongs.