Language

Calendar.IComparable.CompareTo(Object) Method

Definition

Compares this object with the specified object for order.

int IComparable.CompareTo(Java.Lang.Object o);
abstract member Java.Lang.IComparable.CompareTo : Java.Lang.Object -> int
override this.Java.Lang.IComparable.CompareTo : Java.Lang.Object -> int

Parameters

o
Object

the object to be compared.

Returns

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Implements

Remarks

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.) The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0. Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Java reference for java.lang.Comparable.compareTo.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to