public class

LocalVariableImpl

extends Object
implements LocalVariable Mirror
java.lang.Object
   ↳ com.sun.tools.jdi.LocalVariableImpl

Summary

Fields
protected VirtualMachineImpl vm
Public Methods
int compareTo(LocalVariable object)
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
Type findType(String signature)
String genericSignature()
Gets the generic signature for this variable if there is one.
int hashCode()
Returns a hash code value for the object.
boolean isArgument()
Determines if this variable is an argument to its method.
boolean isVisible(StackFrame frame)
Determines whether this variable can be accessed from the given StackFrame.
String name()
Gets the name of the local variable.
String signature()
Gets the JNI signature of the local variable.
String toString()
Returns a string representation of the object.
Type type()
Returns the type of this variable.
String typeName()
Returns a text representation of the type of this variable.
VirtualMachine virtualMachine()
Gets the VirtualMachine to which this Mirror belongs.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.sun.jdi.LocalVariable
From interface com.sun.jdi.Mirror
From interface java.lang.Comparable

Fields

protected VirtualMachineImpl vm

Public Methods

public int compareTo (LocalVariable object)

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 Type findType (String signature)

public String genericSignature ()

Gets the generic signature for this variable if there is one. Generic signatures are described in the "JavaTM Virtual Machine Specification, 3rd Edition.

Returns
  • a string containing the generic signature, or null if there is no generic signature.

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 boolean isArgument ()

Determines if this variable is an argument to its method.

Returns
  • true if this variable is an argument; false otherwise.

public boolean isVisible (StackFrame frame)

Determines whether this variable can be accessed from the given StackFrame. See visibleVariables() for a complete description variable visibility in this interface.

Parameters
frame the StackFrame querying visibility
Returns
  • true if this variable is visible; false otherwise.

public String name ()

Gets the name of the local variable.

Returns
  • a string containing the name.

public String signature ()

Gets the JNI signature of the local variable.

Returns
  • a string containing the signature.

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 Type type ()

Returns the type of this variable. Where the type is the type specified in the declaration of this local variable.

Note: if the type of this variable is a reference type (class, interface, or array) and it has not been created or loaded by the class loader of the enclosing class, then ClassNotLoadedException will be thrown. Also, a reference type may have been loaded but not yet prepared, in which case the type will be returned but attempts to perform some operations on the returned type (e.g. fields()) will throw a ClassNotPreparedException. Use isPrepared() to determine if a reference type is prepared.

Returns
  • the Type of this local variable.

public String typeName ()

Returns a text representation of the type of this variable. Where the type is the type specified in the declaration of this local variable.

This type name is always available even if the type has not yet been created or loaded.

Returns
  • a text representation of the declared type of this variable.

public VirtualMachine virtualMachine ()

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

Returns