2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
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
8 // http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file FBaseInt8Comparer.h
19 * @brief This is the header file for the %Int8Comparer class.
21 * This header file contains the declarations of the %Int8Comparer class.
24 * @see Tizen::Base::Collection::IComparer
26 #ifndef _FBASE_INT8_COMPARER_H_
27 #define _FBASE_INT8_COMPARER_H_
29 #include <FBaseTypes.h>
30 #include <FBaseObject.h>
31 #include <FBaseColIComparer.h>
33 namespace Tizen { namespace Base
37 * @brief This class checks for equivalence between two instances of the %Int8 type.
41 * The %Int8Comparer class checks for equivalence between two instances of the Int8 type.
43 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
45 * The following example demonstrates how to use the %Int8Comparer class.
51 * using namespace Tizen::Base;
54 * MyClass::Int8ComparerSample(void)
58 * Int8Comparer comparer;
61 * comparer.Compare(i1, i2, cmp);
69 class _OSP_EXPORT_ Int8Comparer
71 , public virtual Tizen::Base::Collection::IComparer
75 * This is the default constructor for this class.
83 * This destructor overrides Tizen::Base::Object::~Object().
87 virtual ~Int8Comparer(void);
90 * Compares two given instances of type Int8.
94 * @return An error code
95 * @param[in] obj1 The first instance of type Int8
96 * @param[in] obj2 The second instance of type Int8
97 * @param[out] cmp The result of the comparison
98 * @exception E_SUCCESS The method is successful.
99 * @exception E_INVALID_ARG The specified object instances are not of the expected type.
100 * @remarks The value of @c cmp can be:
103 * < 0 if the value of obj1 is less than the value of obj2
104 * == 0 if the value of obj1 is equal to the value of obj2
105 * > 0 if the value of obj1 is greater than the value of obj2
108 virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
113 * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
115 Int8Comparer(const Int8Comparer& obj);
118 * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
120 Int8Comparer& operator =(const Int8Comparer& rhs);
122 friend class _Int8ComparerImpl;
123 class _Int8ComparerImpl* __pInt8ComparerImpl;
129 #endif // _FBASE_INT8_COMPARER_H_