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

Quick Search    Search Deep

com.go.trove.classfile
Class LocationRangeImpl  view LocationRangeImpl download LocationRangeImpl.java

java.lang.Object
  extended bycom.go.trove.classfile.LocationRangeImpl
All Implemented Interfaces:
java.lang.Comparable, LocationRange

class LocationRangeImpl
extends java.lang.Object
implements LocationRange

Version:
2 , 9/07/00

Field Summary
private  Location mEnd
           
private  Location mStart
           
 
Constructor Summary
(package private) LocationRangeImpl(Location a, Location b)
           
(package private) LocationRangeImpl(LocationRange a, LocationRange b)
           
 
Method Summary
 int compareTo(java.lang.Object obj)
          Compares this object with another, and returns a numerical result based on the comparison.
 boolean equals(java.lang.Object obj)
          Determine whether this Object is semantically equal to another Object.
 Location getEndLocation()
          Returns end of this location range, exclusive.
 Location getStartLocation()
          Returns the start of this location range, inclusive.
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

mStart

private final Location mStart

mEnd

private final Location mEnd
Constructor Detail

LocationRangeImpl

LocationRangeImpl(Location a,
                  Location b)

LocationRangeImpl

LocationRangeImpl(LocationRange a,
                  LocationRange b)
Method Detail

getStartLocation

public Location getStartLocation()
Description copied from interface: LocationRange
Returns the start of this location range, inclusive.

Specified by:
getStartLocation in interface LocationRange

getEndLocation

public Location getEndLocation()
Description copied from interface: LocationRange
Returns end of this location range, exclusive.

Specified by:
getEndLocation in interface LocationRange

equals

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


compareTo

public int compareTo(java.lang.Object obj)
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

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()).