inc/FBaseIntegerComparer.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the License);
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15 //
  16
  17 /**
  18  * @file                FBaseIntegerComparer.h
  19  * @brief               This is the header file for the %IntegerComparer class.
  20  *
  21  * @see                 Integer and Tizen::Base::Collection::IComparer
  22  *
  23  * This header file contains the declarations of the %IntegerComparer class.
  24  */
  25 #ifndef _FBASE_INTEGER_COMPARER_H_
  26 #define _FBASE_INTEGER_COMPARER_H_
  27
  28 #include <FBaseTypes.h>
  29 #include <FBaseObject.h>
  30 #include <FBaseColIComparer.h>
  31
  32 namespace Tizen { namespace Base
  33 {
  34 /**
  35  *      @class  IntegerComparer
  36  *      @brief  This class checks for equivalence between 2 instances of the Integer type.
  37  *
  38  *      @since 2.0
  39  *
  40  *      The %IntegerComparer class checks for equivalence between 2 instances of the Integer type.
  41  *
  42  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
  43  *
  44  * The following example demonstrates how to use the %IntegerComparer class.
  45  *
  46  *      @code
  47  *
  48  *      #include <FBase.h>
  49  *
  50  *      using namespace Tizen::Base;
  51  *
  52  *      void
  53  *      MyClass::IntegerComparerSample(void)
  54  *      {
  55  *              Integer i1(123);
  56  *              Integer i2(124);
  57  *              IntegerComparer comparer;
  58  *
  59  *              int cmp;
  60  *              comparer.Compare(i1, i2, cmp);
  61  *              if (cmp < 0)
  62  *              {
  63  *                      // ...
  64  *              }
  65  *      }
  66  *      @endcode
  67  */
  68 class _OSP_EXPORT_ IntegerComparer
  69         : public Object
  70         , public virtual Tizen::Base::Collection::IComparer
  71 {
  72 public:
  73         /**
  74          *      This is the default constructor for this class.
  75          *
  76          *      @since 2.0
  77          */
  78         IntegerComparer(void);
  79
  80         /**
  81          *      This destructor overrides Tizen::Base::Object::~Object().
  82          *
  83          *      @since 2.0
  84          */
  85         virtual ~IntegerComparer(void);
  86
  87         /**
  88          * Compares two given instances of type Integer.
  89          *
  90          * @since 2.0
  91          *
  92          * @return              An error code
  93          * @param[in]   obj1    The first instance of type %Integer
  94          * @param[in]   obj2    The second instance of type %Integer
  95          * @param[out]  cmp             The result of comparison
  96          * @exception   E_SUCCESS               The method is successful.
  97          * @exception   E_INVALID_ARG   The specified object instances are not of the expected type.
  98          * @remarks     The value of @c cmp can be:
  99          *
 100          * @code
 101          * <  0  if the value of @c obj1 is less than the value of @c obj2
 102          * == 0  if the value of @c obj1 is equal to the value of @c obj2
 103          * >  0  if the value of @c obj1 is greater than the value of @c obj2
 104          * @endcode
 105          */
 106         virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
 107
 108
 109 private:
 110         /**
 111          * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 112          */
 113         IntegerComparer(const IntegerComparer& obj);
 114
 115         /**
 116          * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 117          */
 118         IntegerComparer& operator =(const IntegerComparer& rhs);
 119
 120         friend class _IntegerComparerImpl;
 121         class _IntegerComparerImpl* __pIntegerComparerImpl;
 122
 123 }; // IntegerComparer
 124
 125 }} // Tizen::Base
 126
 127 #endif // _FBASE_INTEGER_COMPARER_H_