gnu.classpath.jdwp.util

Class Location


public class Location
extends Object

A class to read/write JDWP locations.

Constructor Summary

Location(VMMethod method, long index)
Create a location with the given parameters.
Location(ByteBuffer bb)
Read a location from the given bytebuffer, consists of a TAG (byte), followed by a ReferenceTypeId, a MethodId and an index (long).

Method Summary

boolean
equals(Object obj)
Determine whether this Object is semantically equal to another Object.
static Location
getEmptyLocation()
Sets up an empty location
long
getIndex()
Gets the code index of this location
VMMethod
getMethod()
Gets the method of this location
String
toString()
Convert this Object to a human-readable String.
void
write(DataOutputStream os)
Write the given location to an output stream.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Location

public Location(VMMethod method,
                long index)
Create a location with the given parameters.
Parameters:
method - the method
index - location in the method

Location

public Location(ByteBuffer bb)
            throws IOException,
                   JdwpException
Read a location from the given bytebuffer, consists of a TAG (byte), followed by a ReferenceTypeId, a MethodId and an index (long).
Parameters:
bb - this holds the location
Throws:
IOException - when an error occurs reading from the buffer
JdwpException - for invalid class or method IDs

Method Details

equals

public boolean equals(Object obj)
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 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 NullPointerException.

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

The default implementation returns this == o.

Overrides:
equals in interface Object
Parameters:
obj - the Object to compare to
Returns:
whether this Object is semantically equal to another

getEmptyLocation

public static Location getEmptyLocation()
Sets up an empty location
Returns:
new Location (setup as empty)

getIndex

public long getIndex()
Gets the code index of this location
Returns:
the code index

getMethod

public VMMethod getMethod()
Gets the method of this location
Returns:
the method

toString

public String toString()
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() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a 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()).

Overrides:
toString in interface Object
Returns:
the String representing this Object, which may be null

write

public void write(DataOutputStream os)
            throws IOException
Write the given location to an output stream.
Parameters:
os - stream to write to
Throws:
IOException - when an error occurs writing to the stream

Location.java -- class to read/write JDWP locations Copyright (C) 2005, 2006, 2007 Free Software Foundation This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.