org.opensha.sha.earthquake.util
Class EqkRuptureMagComparator

java.lang.Object
  extended by org.opensha.sha.earthquake.util.EqkRuptureMagComparator
All Implemented Interfaces:
java.io.Serializable, java.util.Comparator<EqkRupture>

public class EqkRuptureMagComparator
extends java.lang.Object
implements java.util.Comparator<EqkRupture>, java.io.Serializable

Title: EqkRuptureMagComparator

Description: It compares 2 EqkRupture Object based on their magnitudes.

Version:
1.0
Author:
not attributable
See Also:
Serialized Form

Constructor Summary
EqkRuptureMagComparator()
           
 
Method Summary
 int compare(EqkRupture eqkRup1, EqkRupture eqkRup2)
          Compares its two arguments for order.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Comparator
equals
 

Constructor Detail

EqkRuptureMagComparator

public EqkRuptureMagComparator()
Method Detail

compare

public int compare(EqkRupture eqkRup1,
                   EqkRupture eqkRup2)
Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that sgn(compare(x, y)) == -sgn(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.) The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0. Finally, the implementer must ensure that compare(x, y)==0 implies that sgn(compare(x, z))==sgn(compare(y, z)) for all z. It is generally the case, but not strictly required that (compare(x, y)==0) == (x.equals(y)). Generally speaking, any comparator that violates this condition should clearly indicate this fact. The recommended language is "Note: this comparator imposes orderings that are inconsistent with equals."

Specified by:
compare in interface java.util.Comparator<EqkRupture>
Parameters:
object1 - Object the first object to be compared.
object2 - Object the second object to be compared.
Returns:
int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater