Split CXXFLAGS of the spec file for -D_SECURE_LOG (fixed)
[platform/framework/native/appfw.git] / inc / FBaseLongLongComparer.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                FBaseLongLongComparer.h
19  * @brief               This is the header file for the %LongLongComparer class.
20  *
21  * @see                 Long and Tizen::Base::Collection::IComparer
22  *
23  * This header file contains the declarations of the %LongLongComparer class.
24  */
25 #ifndef _FBASE_LONG_LONG_COMPARER_H_
26 #define _FBASE_LONG_LONG_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       LongLongComparer
36  * @brief       This class checks for equivalence between 2 instances of the %LongLong type.
37  *
38  * @since 2.0
39  *
40  * The %LongLongComparer class checks for equivalence between 2 instances of the %LongLong 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 %LongComparer class.
45  *
46  * @code
47  *
48  *      #include <FBase.h>
49  *
50  *      using namespace Tizen::Base;
51  *
52  *      void
53  *      MyClass::LongLongComparerSample(void)
54  *      {
55  *              LongLong ll1(123);
56  *              LongLong ll2(124);
57  *              LongLongComparer comparer;
58  *
59  *              int cmp;
60  *              comparer.Compare(ll1, ll2, cmp);
61  *              if (cmp < 0)
62  *              {
63  *                      // ...
64  *              }
65  *      }
66  * @endcode
67  */
68 class _OSP_EXPORT_ LongLongComparer
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         LongLongComparer(void);
79
80         /**
81          * This destructor overrides Tizen::Base::Object::~Object().
82          *
83          * @since 2.0
84          */
85         virtual ~LongLongComparer(void);
86
87         /**
88          * Compares two given instances of type LongLong.
89          *
90          * @since 2.0
91          * @return              An error code
92          * @param[in]   obj1                    The first instance of type LongLong
93          * @param[in]   obj2                    The second instance of type LongLong
94          * @param[out] cmp                              The result of comparison
95          * @exception   E_SUCCESS               The method is successful.
96          * @exception   E_INVALID_ARG   The specified object instances are not of the expected type.
97          * @remarks     The value of @c cmp can be:
98          *
99          * @code
100          *      <  0  if the value of @c obj1 is less than the value of @c obj2
101          *      == 0  if the value of @c obj1 is equal to the value of @c obj2
102          *      >  0  if the value of @c obj1 is greater than the value of @c obj2
103          * @endcode
104          */
105         virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
106
107
108 private:
109         /**
110          * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
111          */
112         LongLongComparer(const LongLongComparer& obj);
113
114         /**
115          * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
116          */
117         LongLongComparer& operator =(const LongLongComparer& rhs);
118
119         friend class _LongLongComparerImpl;
120         class _LongLongComparerImpl* __pLongLongComparerImpl;
121
122 }; // LongLongComparer
123
124 }} // Tizen::Base
125
126 #endif // _FBASE_LONG_LONG_COMPARER_H_