00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_COMPARABLE_HPP 00008 #define COH_COMPARABLE_HPP 00009 00010 #include "coherence/lang/compatibility.hpp" 00011 00012 #include "coherence/lang/interface_spec.hpp" 00013 #include "coherence/lang/Object.hpp" 00014 #include "coherence/lang/TypedHandle.hpp" 00015 00016 COH_OPEN_NAMESPACE2(coherence,lang) 00017 00018 00019 /** 00020 * This interface imposes a total ordering on the objects of each class that 00021 * implements it. This ordering is referred to as the class's <i>natural 00022 * ordering</i>, and the class's <tt>compareTo</tt> method is referred to as 00023 * its <i>natural comparison method</i>. 00024 * 00025 * @author jh 2008.02.27 00026 */ 00027 class COH_EXPORT Comparable 00028 : public interface_spec<Comparable> 00029 { 00030 // ----- Comparable interface ------------------------------------------- 00031 00032 public: 00033 /** 00034 * Compare this object with the specified object for order. Return a 00035 * negative integer, zero, or a positive integer if this object is 00036 * less than, equal to, or greater than the specified object. 00037 * 00038 * It is strongly recommended, but <i>not</i> strictly required, that 00039 * <tt>(x->compareTo(y) == 0) == (x->equals(y))</tt>. 00040 * 00041 * @param v the Object to be compared 00042 * 00043 * @return a negative integer, zero, or a positive integer if this 00044 * object is less than, equal to, or greater than the 00045 * specified object 00046 * 00047 * @throws ClassCastException if the specified Object's type prevents it 00048 * from being compared to this Object 00049 */ 00050 virtual int32_t compareTo(Object::View v) const = 0; 00051 00052 /** 00053 * Standard C++ less-than operator delegate. 00054 * 00055 * @param v the Object to be compared 00056 * 00057 * @return true if this object is less than the specified object 00058 */ 00059 virtual bool operator<(Object::View v) const 00060 { 00061 return compareTo(v) < 0; 00062 } 00063 }; 00064 00065 COH_CLOSE_NAMESPACE2 00066 00067 #endif // COH_COMPARABLE_HPP