inc/FBaseInteger8Comparer.h

   1 //
   2 // Copyright (c) 2013 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                FBaseInteger8Comparer.h
  19  * @brief               This is the header file for the %Integer8Comparer class.
  20  *
  21  * @see                 Integer8 and Tizen::Base::Collection::IComparer
  22  *
  23  * This header file contains the declarations of the %Integer8Comparer class.
  24  */
  25 #ifndef  _FBASE_INTEGER8_COMPARER_H_
  26 #define  _FBASE_INTEGER8_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  Integer8Comparer
  36  *      @brief  This class checks for equivalence between 2 instances of the %Integer8 type.
  37  *
  38  *      @since 3.0
  39  *
  40  *      The %Integer8Comparer class checks for equivalence between 2 instances of the Integer8 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 %Integer8Comparer class.
  45  *
  46  *      @code
  47  *
  48  *      #include <FBase.h>
  49  *
  50  *      using namespace Tizen::Base;
  51  *
  52  *      void
  53  *      MyClass::Integer8ComparerSample(void)
  54  *      {
  55  *              Integer8 i1(123);
  56  *              Integer8 i2(124);
  57  *              Integer8Comparer 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_ Integer8Comparer
  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 3.0
  77          */
  78         Integer8Comparer(void);
  79
  80
  81         /**
  82          *      This destructor overrides Tizen::Base::Object::~Object().
  83          *
  84          *      @since 3.0
  85          */
  86         virtual ~Integer8Comparer(void);
  87
  88         /**
  89          *      Compares two given instances of type Integer8.
  90          *
  91          *      @since 3.0
  92          *
  93          *  @return             An error code
  94          *  @param[in]  obj1    The first instance of type Integer8
  95          *  @param[in]  obj2    The second instance of type Integer8
  96          *  @param[out] cmp             The result of comparison
  97          *  @exception  E_SUCCESS               The method is successful.
  98          *  @exception  E_INVALID_ARG   The specified object instances are not of the expected type.
  99          *  @remarks    The value of @c cmp can be:
 100          *
 101          *      @code
 102          *      <  0  if the value of @c obj1 is less than the value of @c obj2
 103          *      == 0  if the value of @c obj1 is equal to the value of @c obj2
 104          *      >  0  if the value of @c obj1 is greater than the value of @c obj2
 105          *      @endcode
 106          */
 107         virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
 108
 109
 110 private:
 111         //
 112         // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 113         //
 114         Integer8Comparer(const Integer8Comparer& obj);
 115
 116         //
 117         // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 118         //
 119         Integer8Comparer& operator =(const Integer8Comparer& rhs);
 120
 121         friend class _Integer8ComparerImpl;
 122         class _Integer8ComparerImpl* __pInteger8ComparerImpl;
 123
 124 }; // Integer8Comparer
 125
 126 }} // Tizen::Base
 127
 128 #endif //  _FBASE_INTEGER8_COMPARER_H_