public class

StackFrameImpl

extends Object
implements Mirror StackFrame EventListener
java.lang.Object
   ↳ com.sun.tools.jdi.StackFrameImpl

Summary

Fields
protected VirtualMachineImpl vm
Public Methods
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
List<Value> getArgumentValues()
Returns the values of all arguments in this frame.
Value getValue(LocalVariable variable)
Gets the Value of a LocalVariable in this frame.
Map<LocalVariableValue> getValues(List<? extends LocalVariable> variables)
Returns the values of multiple local variables in this frame.
int hashCode()
Returns a hash code value for the object.
Location location()
Return the frame location.
void setValue(LocalVariable variableIntf, Value valueIntf)
Sets the Value of a LocalVariable in this frame.
ObjectReference thisObject()
Returns the value of 'this' for the current frame.
ThreadReference thread()
Return the thread holding the frame.
boolean threadResumable(ThreadAction action)
String toString()
Returns a string representation of the object.
VirtualMachine virtualMachine()
Gets the VirtualMachine to which this Mirror belongs.
LocalVariable visibleVariableByName(String name)
Return a particular variable in the frame.
List<LocalVariable> visibleVariables()
Return the list of visible variable in the frame.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.sun.jdi.Locatable
From interface com.sun.jdi.Mirror
From interface com.sun.jdi.StackFrame

Fields

protected VirtualMachineImpl vm

Public Methods

public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj the reference object with which to compare.
Returns
  • true if this object is the same as the obj argument; false otherwise.

public List<Value> getArgumentValues ()

Returns the values of all arguments in this frame. Values are returned even if no local variable information is present.

Returns
  • a list containing a Value object for each argument to this frame, in the order in which the arguments were declared. If the method corresponding to this frame has no arguments, an empty list is returned.

public Value getValue (LocalVariable variable)

Gets the Value of a LocalVariable in this frame. The variable must be valid for this frame's method and visible according to the rules described in visibleVariables().

Parameters
variable the LocalVariable to be accessed
Returns
  • the Value of the instance field.

public Map<LocalVariableValue> getValues (List<? extends LocalVariable> variables)

Returns the values of multiple local variables in this frame. Each variable must be valid for this frame's method and visible according to the rules described in visibleVariables().

Parameters
variables a list of LocalVariable objects to be accessed
Returns

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
  • a hash code value for this object.

public Location location ()

Return the frame location. Need not be synchronized since it cannot be provably stale.

Returns
  • the Location of the current instruction.

public void setValue (LocalVariable variableIntf, Value valueIntf)

Sets the Value of a LocalVariable in this frame. The variable must be valid for this frame's method and visible according to the rules described in visibleVariables().

Object values must be assignment compatible with the variable type (This implies that the variable type must be loaded through the enclosing class's class loader). Primitive values must be either assignment compatible with the variable type or must be convertible to the variable type without loss of information. See JLS section 5.2 for more information on assignment compatibility.

Parameters
variableIntf the field containing the requested value
valueIntf the new value to assign

public ObjectReference thisObject ()

Returns the value of 'this' for the current frame. The ObjectReference for 'this' is only available for non-native instance methods.

Returns
  • an ObjectReference, or null if the frame represents a native or static method.

public ThreadReference thread ()

Return the thread holding the frame. Need not be synchronized since it cannot be provably stale.

Returns

public boolean threadResumable (ThreadAction action)

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
  • a string representation of the object.

public VirtualMachine virtualMachine ()

Gets the VirtualMachine to which this Mirror belongs. A Mirror must be associated with a VirtualMachine to have any meaning.

Returns

public LocalVariable visibleVariableByName (String name)

Return a particular variable in the frame. Need not be synchronized since it cannot be provably stale.

Parameters
name the variable name to find
Returns
  • the matching LocalVariable, or null if there is no visible variable with the given name; frames in native methods will always return null.

public List<LocalVariable> visibleVariables ()

Return the list of visible variable in the frame. Need not be synchronized since it cannot be provably stale.

Returns
  • the list of LocalVariable objects currently visible; the list will be empty if there are no visible variables; specifically, frames in native methods will always return a zero-length list.