public interface

LocalVariable

implements Mirror Comparable<T>
com.sun.jdi.LocalVariable
Known Indirect Subclasses

Class Overview

A local variable in the target VM. Each variable declared within a Method has its own LocalVariable object. Variables of the same name declared in different scopes have different LocalVariable objects. LocalVariables can be used alone to retrieve static information about their declaration, or can be used in conjunction with a StackFrame to set and get values.

See Also

Summary

Public Methods
abstract boolean equals(Object obj)
Compares the specified Object with this LocalVariable for equality.
abstract String genericSignature()
Gets the generic signature for this variable if there is one.
abstract int hashCode()
Returns the hash code value for this LocalVariable.
abstract boolean isArgument()
Determines if this variable is an argument to its method.
abstract boolean isVisible(StackFrame frame)
Determines whether this variable can be accessed from the given StackFrame.
abstract String name()
Gets the name of the local variable.
abstract String signature()
Gets the JNI signature of the local variable.
abstract Type type()
Returns the type of this variable.
abstract String typeName()
Returns a text representation of the type of this variable.
[Expand]
Inherited Methods
From interface com.sun.jdi.Mirror
From interface java.lang.Comparable

Public Methods

public abstract boolean equals (Object obj)

Compares the specified Object with this LocalVariable for equality.

Parameters
obj the reference object with which to compare.
Returns
  • true if the Object is a LocalVariable, if both LocalVariables are contained in the same method (as determined by equals(Object)), and if both LocalVariables mirror the same declaration within that method

public abstract 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 abstract int hashCode ()

Returns the hash code value for this LocalVariable.

Returns
  • the integer hash code

public abstract boolean isArgument ()

Determines if this variable is an argument to its method.

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

public abstract 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.
Throws
IllegalArgumentException if the stack frame's method does not match this variable's method.

public abstract String name ()

Gets the name of the local variable.

Returns
  • a string containing the name.

public abstract String signature ()

Gets the JNI signature of the local variable.

Returns
  • a string containing the signature.
See Also

public abstract 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.
Throws
ClassNotLoadedException if the type has not yet been loaded through the appropriate class loader.
See Also

public abstract 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 String representing the type of this local variable.