inc/FBaseInt8Comparer.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                FBaseInt8Comparer.h
  19  * @brief               This is the header file for the %Int8Comparer class.
  20  * @brief       <i> [Deprecated] </i>
  21  * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8Comparer class.
  22  *
  23  * @see                 Int8 and Tizen::Base::Collection::IComparer
  24  *
  25  * This header file contains the declarations of the %Int8Comparer class.
  26  */
  27 #ifndef _FBASE_INT8_COMPARER_H_
  28 #define _FBASE_INT8_COMPARER_H_
  29
  30 #include <FBaseTypes.h>
  31 #include <FBaseObject.h>
  32 #include <FBaseColIComparer.h>
  33
  34 namespace Tizen { namespace Base
  35 {
  36 /**
  37  *      @class  Int8Comparer
  38  *      @brief  This class checks for equivalence between 2 instances of the %Int8 type.
  39  *
  40  *      @since 2.0
  41  *
  42  *      The %Int8Comparer class checks for equivalence between 2 instances of the Int8 type.
  43  *
  44  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
  45  *
  46  * The following example demonstrates how to use the %Int8Comparer class.
  47  *
  48  *      @code
  49  *
  50  *      #include <FBase.h>
  51  *
  52  *      using namespace Tizen::Base;
  53  *
  54  *      void
  55  *      MyClass::Int8ComparerSample(void)
  56  *      {
  57  *              Int8 i1(123);
  58  *              Int8 i2(124);
  59  *              Int8Comparer comparer;
  60  *
  61  *              int cmp;
  62  *              comparer.Compare(i1, i2, cmp);
  63  *              if (cmp < 0)
  64  *              {
  65  *                      // ...
  66  *              }
  67  *      }
  68  *      @endcode
  69  */
  70 class _OSP_EXPORT_ Int8Comparer
  71         : public Object
  72         , public virtual Tizen::Base::Collection::IComparer
  73 {
  74 public:
  75         /**
  76          *      This is the default constructor for this class.
  77          *
  78          *      @since 2.0
  79          * @brief       <i> [Deprecated] </i>
  80          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8Comparer class.
  81          */
  82         Int8Comparer(void);
  83
  84
  85         /**
  86          *      This destructor overrides Tizen::Base::Object::~Object().
  87          *
  88          *      @since 2.0
  89          * @brief       <i> [Deprecated] </i>
  90          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8Comparer class.
  91          */
  92         virtual ~Int8Comparer(void);
  93
  94         /**
  95          *      Compares two given instances of type Int8.
  96          *
  97          *      @since 2.0
  98          * @brief       <i> [Deprecated] </i>
  99          * @deprecated  This class is deprecated because char is treated as unsigned char in ARM architecture. Use Integer8Comparer class.
 100          *
 101          *  @return             An error code
 102          *  @param[in]  obj1    The first instance of type Int8
 103          *  @param[in]  obj2    The second instance of type Int8
 104          *  @param[out] cmp             The result of comparison
 105          *  @exception  E_SUCCESS               The method is successful.
 106          *  @exception  E_INVALID_ARG   The specified object instances are not of the expected type.
 107          *  @remarks    The value of @c cmp can be:
 108          *
 109          *      @code
 110          *      <  0  if the value of @c obj1 is less than the value of @c obj2
 111          *      == 0  if the value of @c obj1 is equal to the value of @c obj2
 112          *      >  0  if the value of @c obj1 is greater than the value of @c obj2
 113          *      @endcode
 114          */
 115         virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
 116
 117
 118 private:
 119         /**
 120          * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 121          */
 122         Int8Comparer(const Int8Comparer& obj);
 123
 124         /**
 125          * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 126          */
 127         Int8Comparer& operator =(const Int8Comparer& rhs);
 128
 129         friend class _Int8ComparerImpl;
 130         class _Int8ComparerImpl* __pInt8ComparerImpl;
 131
 132 }; // Int8Comparer
 133
 134 }} // Tizen::Base
 135
 136 #endif // _FBASE_INT8_COMPARER_H_