Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.jdi.internal
Class LocalVariableImpl  view LocalVariableImpl download LocalVariableImpl.java

java.lang.Object
  extended byorg.eclipse.jdi.internal.MirrorImpl
      extended byorg.eclipse.jdi.internal.LocalVariableImpl
All Implemented Interfaces:
java.lang.Comparable, com.sun.jdi.LocalVariable, com.sun.jdi.Mirror

public class LocalVariableImpl
extends MirrorImpl
implements com.sun.jdi.LocalVariable

this class implements the corresponding interfaces declared by the JDI specification. See the com.sun.jdi package for more information.


Field Summary
private  long fCodeIndex
          First code index at which the variable is visible (unsigned).
private  java.lang.String fGenericSignature
          The variable type generic signature.
private  boolean fIsArgument
          Is the local variable an argument of its method?
private  int fLength
          Unsigned value used in conjunction with codeIndex.
private  MethodImpl fMethod
          Method that holds local variable.
private  java.lang.String fName
          The variable's name.
private  java.lang.String fSignature
          The variable type's JNI signature.
private  int fSlot
          The local variable's index in its frame.
 
Fields inherited from class org.eclipse.jdi.internal.MirrorImpl
fDescription, fVerboseWriter
 
Constructor Summary
LocalVariableImpl(VirtualMachineImpl vmImpl, MethodImpl method, long codeIndex, java.lang.String name, java.lang.String signature, java.lang.String genericSignature, int length, int slot, boolean isArgument)
           
 
Method Summary
 int compareTo(java.lang.Object object)
          Compares this object with another, and returns a numerical result based on the comparison.
 boolean equals(java.lang.Object object)
          Determine whether this Object is semantically equal to another Object.
 java.lang.String genericSignature()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 boolean isArgument()
           
 boolean isThis()
           
 boolean isVisible(com.sun.jdi.StackFrame frame)
           
 MethodImpl method()
           
 java.lang.String name()
           
 java.lang.String signature()
           
 int slot()
           
 byte tag()
           
 java.lang.String toString()
          Convert this Object to a human-readable String.
 com.sun.jdi.Type type()
           
 java.lang.String typeName()
           
 
Methods inherited from class org.eclipse.jdi.internal.MirrorImpl
checkVM, defaultIOExceptionHandler, defaultReplyErrorHandler, disconnectVM, getCommandVM, handledJdwpEventSet, handledJdwpRequest, initJdwpEventSet, initJdwpRequest, readBoolean, readByte, readByte, readByte, readByteArray, readChar, readDouble, readFloat, readInt, readInt, readInt, readLong, readShort, readShort, readShort, readString, requestVM, requestVM, requestVM, requestVM, requestVM, verboseWriter, virtualMachine, virtualMachineImpl, writeBoolean, writeByte, writeByte, writeByte, writeChar, writeDouble, writeFloat, writeInt, writeInt, writeInt, writeLong, writeShort, writeShort, writeShort, writeString, writeVerboseCommandPacketHeader
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.sun.jdi.Mirror
virtualMachine
 

Field Detail

fMethod

private MethodImpl fMethod
Method that holds local variable.


fCodeIndex

private long fCodeIndex
First code index at which the variable is visible (unsigned).


fName

private java.lang.String fName
The variable's name.


fSignature

private java.lang.String fSignature
The variable type's JNI signature.


fGenericSignature

private java.lang.String fGenericSignature
The variable type generic signature.


fLength

private int fLength
Unsigned value used in conjunction with codeIndex. The variable can be get or set only when the current codeIndex <= current frame code index < code index + length.

The length is set to -1 when this variable represents an inferred argument (when local var info is unavailable). We assume that such arguments are visible for the entire method.


fSlot

private int fSlot
The local variable's index in its frame.


fIsArgument

private boolean fIsArgument
Is the local variable an argument of its method?

Constructor Detail

LocalVariableImpl

public LocalVariableImpl(VirtualMachineImpl vmImpl,
                         MethodImpl method,
                         long codeIndex,
                         java.lang.String name,
                         java.lang.String signature,
                         java.lang.String genericSignature,
                         int length,
                         int slot,
                         boolean isArgument)
Method Detail

slot

public int slot()

hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Specified by:
hashCode in interface com.sun.jdi.LocalVariable

equals

public boolean equals(java.lang.Object object)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Specified by:
equals in interface com.sun.jdi.LocalVariable

compareTo

public int compareTo(java.lang.Object object)
Description copied from interface: java.lang.Comparable
Compares this object with another, and returns a numerical result based on the comparison. If the result is negative, this object sorts less than the other; if 0, the two are equal, and if positive, this object sorts greater than the other. To translate this into boolean, simply perform o1.compareTo(o2) <op> 0, where op is one of <, <=, =, !=, >, or >=.

You must make sure that the comparison is mutual, ie. sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) (where sgn() is defined as -1, 0, or 1 based on the sign). This includes throwing an exception in either direction if the two are not comparable; hence, compareTo(null) should always throw an Exception.

You should also ensure transitivity, in two forms: x.compareTo(y) > 0 && y.compareTo(z) > 0 implies x.compareTo(z) > 0; and x.compareTo(y) == 0 implies x.compareTo(z) == y.compareTo(z).

Specified by:
compareTo in interface java.lang.Comparable

isArgument

public boolean isArgument()
Specified by:
isArgument in interface com.sun.jdi.LocalVariable

isVisible

public boolean isVisible(com.sun.jdi.StackFrame frame)
                  throws java.lang.IllegalArgumentException,
                         com.sun.jdi.VMMismatchException
Specified by:
isVisible in interface com.sun.jdi.LocalVariable

name

public java.lang.String name()
Specified by:
name in interface com.sun.jdi.LocalVariable

signature

public java.lang.String signature()
Specified by:
signature in interface com.sun.jdi.LocalVariable

type

public com.sun.jdi.Type type()
                      throws com.sun.jdi.ClassNotLoadedException
Specified by:
type in interface com.sun.jdi.LocalVariable

typeName

public java.lang.String typeName()
Specified by:
typeName in interface com.sun.jdi.LocalVariable

tag

public byte tag()

method

public MethodImpl method()

isThis

public boolean isThis()

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Specified by:
toString in interface com.sun.jdi.Mirror
Overrides:
toString in class MirrorImpl

genericSignature

public java.lang.String genericSignature()
Specified by:
genericSignature in interface com.sun.jdi.LocalVariable