public class

LocationImpl

extends Object
implements Location Mirror
java.lang.Object
   ↳ com.sun.tools.jdi.LocationImpl

Summary

Fields
protected VirtualMachineImpl vm
Public Methods
long codeIndex()
Gets the code position within this location's method.
int compareTo(Location object)
ReferenceType declaringType()
Gets the type to which this Location belongs.
boolean equals(Object obj)
Indicates whether some other object is "equal to" this one.
int hashCode()
Returns a hash code value for the object.
int lineNumber()
Gets the line number of this Location.
int lineNumber(String stratumID)
The line number of this Location.
Method method()
Gets the method containing this Location.
String sourceName(String stratumID)
Gets an identifing name for the source corresponding to this location.
String sourceName()
Gets an identifing name for the source corresponding to this location.
String sourcePath()
Gets the path to the source corresponding to this location.
String sourcePath(String stratumID)
Gets the path to the source corresponding to this location.
String toString()
Returns a string representation of the object.
VirtualMachine virtualMachine()
Gets the VirtualMachine to which this Mirror belongs.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.sun.jdi.Location
From interface com.sun.jdi.Mirror
From interface java.lang.Comparable

Fields

protected VirtualMachineImpl vm

Public Methods

public long codeIndex ()

Gets the code position within this location's method.

Returns
  • the long representing the position within the method or -1 if location is within a native method.

public int compareTo (Location object)

public ReferenceType declaringType ()

Gets the type to which this Location belongs. Normally the declaring type is a ClassType, but executable locations also may exist within the static initializer of an InterfaceType.

Returns

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 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 int lineNumber ()

Gets the line number of this Location.

This method is equivalent to lineNumber(vm.getDefaultStratum()) - see lineNumber(String) for more information.

Returns
  • an int specifying the line in the source, returns -1 if the information is not available; specifically, always returns -1 for native methods.

public int lineNumber (String stratumID)

The line number of this Location. The line number is relative to the source specified by sourceName(stratum).

Returned line number is for the specified stratum (see the class comment for a description of strata).

Parameters
stratumID The stratum to retrieve information from or null for the declaring type's default stratum.
Returns
  • an int specifying the line in the source, returns -1 if the information is not available; specifically, always returns -1 for native methods.

public Method method ()

Gets the method containing this Location.

Returns

public String sourceName (String stratumID)

Gets an identifing name for the source corresponding to this location. Interpretation of this string is the responsibility of the source repository mechanism.

Returned name is for the specified stratum (see the class comment for a description of strata).

The returned string is the unqualified name of the source file for this Location. For example, java.lang.Thread would return "Thread.java".

Parameters
stratumID The stratum to retrieve information from or null for the declaring type's default stratum.
Returns
  • a string specifying the source

public String sourceName ()

Gets an identifing name for the source corresponding to this location.

This method is equivalent to sourceName(vm.getDefaultStratum()) - see sourceName(String) for more information.

Returns
  • a string specifying the source

public String sourcePath ()

Gets the path to the source corresponding to this location.

This method is equivalent to sourcePath(vm.getDefaultStratum()) - see sourcePath(String) for more information.

Returns
  • a string specifying the source

public String sourcePath (String stratumID)

Gets the path to the source corresponding to this location. Interpretation of this string is the responsibility of the source repository mechanism.

Returned path is for the specified stratum (see the class comment for a description of strata).

In the reference implementation, for strata which do not explicitly specify source path (the Java programming language stratum never does), the returned string is the package name of declaringType() converted to a platform dependent path followed by the unqualified name of the source file for this Location (sourceName(stratum)). For example, on a Windows platform, java.lang.Thread would return "java\lang\Thread.java".

Parameters
stratumID The stratum to retrieve information from or null for the declaring type's default stratum.
Returns
  • a string specifying the source

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