flex.tools.debugger.cli

Class VariableFacade

java.lang.Object

flex.tools.debugger.cli.VariableFacade

All Implemented Interfaces:

Variable

public class VariableFacade
extends Object
implements Variable

A VariableFacade provides a wrapper around a Variable object that provides a convenient way of storing parent information. Don't ask me why we didn't just add a parent member to Variable and be done with it.

Constructor Summary

Constructors

Constructor and Description
VariableFacade(long context, String name, int m_isolateId)
VariableFacade(Variable v, long context, int m_isolateId)

Method Summary

Methods

Modifier and Type	Method and Description
int	getAttributes() Variable attributes define further information regarding the variable.
long	getContext() Our lone get context (i.e. parent) interface
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 variable interface
String	getNamespace() The namespace of the variable.
String	getPath()
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.
Variable	getVariable()
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()
void	setPath(String path)
FaultEvent	setValue(Session s, int type, String value) Changes the value of a variable.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableFacade

public VariableFacade(Variable v,
              long context,
              int m_isolateId)

VariableFacade

public VariableFacade(long context,
              String name,
              int m_isolateId)

Method Detail

getName

public String getName()

The variable interface

Specified by:

getName in interface Variable

getQualifiedName

public String getQualifiedName()

Description copied from interface: Variable

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

Specified by:

getQualifiedName in interface Variable

getNamespace

public String getNamespace()

Description copied from interface: Variable

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".

Specified by:

getNamespace in interface Variable

Returns:

namespace or "", never null

getLevel

public int getLevel()

Description copied from interface: Variable

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.

Specified by:

getLevel in interface Variable

getDefiningClass

public String getDefiningClass()

Description copied from interface: Variable

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.

Specified by:

getDefiningClass in interface Variable

getAttributes

public int getAttributes()

Description copied from interface: Variable

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

Specified by:

getAttributes in interface Variable

See Also:

VariableAttribute

getScope

public int getScope()

Description copied from interface: Variable

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 "==".

Specified by:

getScope in interface Variable

See Also:

VariableAttribute

isAttributeSet

public boolean isAttributeSet(int variableAttribute)

Specified by:

isAttributeSet in interface Variable

See Also:

VariableAttribute

getValue

public Value getValue()

Description copied from interface: Variable

Returns the value of the variable.

Specified by:

getValue in interface Variable

hasValueChanged

public boolean hasValueChanged(Session s)

Description copied from interface: Variable

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.

Specified by:

hasValueChanged in interface Variable

setValue

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

Description copied from interface: Variable

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

Specified by:

setValue in interface Variable

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:

NotSuspendedException - if Player is running

NoResponseException - if times out

NotConnectedException - if Player is disconnected from Session

toString

public String toString()

Overrides:

toString in class Object

getPath

public String getPath()

setPath

public void setPath(String path)

needsToInvokeGetter

public boolean needsToInvokeGetter()

Specified by:

needsToInvokeGetter in interface Variable

Returns:

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

invokeGetter

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

Description copied from interface: Variable

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.

Specified by:

invokeGetter in interface Variable

Throws:

NotSuspendedException

NoResponseException

NotConnectedException

getContext

public long getContext()

Our lone get context (i.e. parent) interface

getVariable

public Variable getVariable()

getIsolateId

public int getIsolateId()

Description copied from interface: Variable

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

Specified by:

getIsolateId in interface Variable