OpenJDK 27 · com.sun.tools.jdi.LocalVariableImpl · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private String	genericSignature
private final Method	method
private final String	name
private final Location	scopeEnd
private final Location	scopeStart
private final String	signature
private final int	slot

Access	Constructor and Description
pack-priv	LocalVariableImpl(VirtualMachine vm, Method method, int slot, Location scopeStart, Location scopeEnd, String name, String signature, String genericSignature)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(LocalVariable object) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object obj) Overrides com.sun.tools.jdi.MirrorImpl.equals. Implements com.sun.jdi.LocalVariable.equals. Compares the specified Object with this LocalVariable for equality.
public Type	findType(String signature) Implements com.sun.tools.jdi.ValueContainer.findType.
public String	genericSignature() Implements com.sun.jdi.LocalVariable.genericSignature. Gets the generic signature for this variable if there is one.
public int	hashCode() Overrides com.sun.tools.jdi.MirrorImpl.hashCode. Implements com.sun.jdi.LocalVariable.hashCode. Returns the hash code value for this LocalVariable.
pack-priv boolean	hides(LocalVariable other)
public boolean	isArgument() Implements com.sun.jdi.LocalVariable.isArgument. Determines if this variable is an argument to its method.
public boolean	isVisible(StackFrame frame) Implements com.sun.jdi.LocalVariable.isVisible. Determines whether this variable can be accessed from the given `StackFrame`.
public String	name() Implements com.sun.jdi.LocalVariable.name. Gets the name of the local variable.
public String	signature() Implements com.sun.jdi.LocalVariable.signature, com.sun.tools.jdi.ValueContainer.signature. Gets the type signature of the local variable.
pack-priv int	slot()
public String	toString() Overrides java.lang.Object.toString. Implements com.sun.jdi.Mirror.toString. Returns a String describing this mirror
public Type	type() Implements com.sun.jdi.LocalVariable.type, com.sun.tools.jdi.ValueContainer.type. Returns the type of this variable.
public String	Returns: a text representation of the declared type of this variable. typeName() Implements com.sun.jdi.LocalVariable.typeName, com.sun.tools.jdi.ValueContainer.typeName. Returns a text representation of the type of this variable.

Inherited from com.sun.tools.jdi.MirrorImpl:: validateMirror validateMirrorOrNull validateMirrors validateMirrorsOrNulls virtualMachine

genericSignature	back to summary
private String genericSignature

method	back to summary
private final Method method

name	back to summary
private final String name

scopeEnd	back to summary
private final Location scopeEnd

scopeStart	back to summary
private final Location scopeStart

signature	back to summary
private final String signature

slot	back to summary
private final int slot

LocalVariableImpl	back to summary
pack-priv LocalVariableImpl(VirtualMachine vm, Method method, int slot, Location scopeStart, Location scopeEnd, String name, String signature, String genericSignature)

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(LocalVariable object) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`.

public int compareTo(LocalVariable object)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

equals	back to summary
public boolean equals(Object obj) Overrides com.sun.tools.jdi.MirrorImpl.equals. Implements com.sun.jdi.LocalVariable.equals. Doc from com.sun.jdi.LocalVariable.equals. Compares the specified Object with this LocalVariable for equality.

equals

back to summary

public boolean equals(Object obj)

Overrides com.sun.tools.jdi.MirrorImpl.equals.

Implements com.sun.jdi.LocalVariable.equals.

Doc from com.sun.jdi.LocalVariable.equals.

Compares the specified Object with this LocalVariable for equality.

findType	back to summary
public Type findType(String signature) throws ClassNotLoadedException Implements com.sun.tools.jdi.ValueContainer.findType.

genericSignature	back to summary
public String genericSignature() Implements com.sun.jdi.LocalVariable.genericSignature. Doc from com.sun.jdi.LocalVariable.genericSignature. Gets the generic signature for this variable if there is one. Generic signatures are described in the The Java Virtual Machine Specification.

genericSignature

back to summary

public String genericSignature()

Implements com.sun.jdi.LocalVariable.genericSignature.

Doc from com.sun.jdi.LocalVariable.genericSignature.

Gets the generic signature for this variable if there is one. Generic signatures are described in the The Java Virtual Machine Specification.

hashCode	back to summary
public int hashCode() Overrides com.sun.tools.jdi.MirrorImpl.hashCode. Implements com.sun.jdi.LocalVariable.hashCode. Doc from com.sun.jdi.LocalVariable.hashCode. Returns the hash code value for this LocalVariable.

hashCode

back to summary

public int hashCode()

Overrides com.sun.tools.jdi.MirrorImpl.hashCode.

Implements com.sun.jdi.LocalVariable.hashCode.

Doc from com.sun.jdi.LocalVariable.hashCode.

Returns the hash code value for this LocalVariable.

hides	back to summary
pack-priv boolean hides(LocalVariable other)

isArgument	back to summary
public boolean isArgument() Implements com.sun.jdi.LocalVariable.isArgument. Doc from com.sun.jdi.LocalVariable.isArgument. Determines if this variable is an argument to its method.

isArgument

back to summary

public boolean isArgument()

Implements com.sun.jdi.LocalVariable.isArgument.

Doc from com.sun.jdi.LocalVariable.isArgument.

Determines if this variable is an argument to its method.

isVisible back to summary

isVisible	back to summary
public boolean isVisible(StackFrame frame) Implements com.sun.jdi.LocalVariable.isVisible. Doc from com.sun.jdi.LocalVariable.isVisible. Determines whether this variable can be accessed from the given `StackFrame`. See `StackFrame#visibleVariables` for a complete description variable visibility in this interface.

public boolean isVisible(StackFrame frame)

Implements com.sun.jdi.LocalVariable.isVisible.

Doc from com.sun.jdi.LocalVariable.isVisible.

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

name	back to summary
public String name() Implements com.sun.jdi.LocalVariable.name. Doc from com.sun.jdi.LocalVariable.name. Gets the name of the local variable.

name

back to summary

public String name()

Implements com.sun.jdi.LocalVariable.name.

Doc from com.sun.jdi.LocalVariable.name.

Gets the name of the local variable.

signature	back to summary
public String signature() Implements com.sun.jdi.LocalVariable.signature, com.sun.tools.jdi.ValueContainer.signature. Doc from com.sun.jdi.LocalVariable.signature. Gets the type signature of the local variable.

signature

back to summary

public String signature()

Implements com.sun.jdi.LocalVariable.signature, com.sun.tools.jdi.ValueContainer.signature.

Doc from com.sun.jdi.LocalVariable.signature.

Gets the type signature of the local variable.

slot	back to summary
pack-priv int slot()

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements com.sun.jdi.Mirror.toString. Doc from com.sun.jdi.Mirror.toString. Returns a String describing this mirror

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements com.sun.jdi.Mirror.toString.

Doc from com.sun.jdi.Mirror.toString.

Returns a String describing this mirror

type back to summary

type	back to summary
public Type type() throws ClassNotLoadedException Implements com.sun.jdi.LocalVariable.type, com.sun.tools.jdi.ValueContainer.type. Doc from com.sun.jdi.LocalVariable.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 `ReferenceType#isPrepared()` to determine if a reference type is prepared. Exceptions ClassNotLoadedException: if the type has not yet been loaded through the appropriate class loader.

public Type type() throws ClassNotLoadedException

Implements com.sun.jdi.LocalVariable.type, com.sun.tools.jdi.ValueContainer.type.

Doc from com.sun.jdi.LocalVariable.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 ReferenceType#isPrepared() to determine if a reference type is prepared.

Exceptions

ClassNotLoadedException:: if the type has not yet been loaded through the appropriate class loader.

typeName	back to summary
public String typeName() Implements com.sun.jdi.LocalVariable.typeName, com.sun.tools.jdi.ValueContainer.typeName. Doc from com.sun.jdi.LocalVariable.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:String a text representation of the declared type of this variable.

typeName

back to summary

public String typeName()

Implements com.sun.jdi.LocalVariable.typeName, com.sun.tools.jdi.ValueContainer.typeName.

Doc from com.sun.jdi.LocalVariable.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:String: a text representation of the declared type of this variable.

public Class LocalVariableImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail