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 FBaseColIComparerT.h
19 * @brief This is the header file for the %IComparerT interface.
21 * This header file contains the declarations of the %IComparerT interface.
23 #ifndef _FBASE_COL_ICOMPARER_T_H_
24 #define _FBASE_COL_ICOMPARER_T_H_
26 #include <FBaseTypes.h>
29 namespace Tizen { namespace Base { namespace Collection
32 * @interface IComparerT
33 * @brief This interface allows derived classes to compare 2 template-based objects of the same type.
37 * The %IComparerT interface allows derived classes to compare 2 template-based objects of the
40 template< class Type >
45 * This polymorphic destructor should be overridden if required. @n
46 * This way, the destructors of the derived classes are called when the destructor of this interface is called.
50 virtual ~IComparerT(void) { }
54 * Compares two given instances of the same type.
58 * @return An error code
59 * @param[in] obj1 The first object to compare
60 * @param[in] obj2 The second object to compare
61 * @param[out] cmp The result of comparison
62 * @exception E_SUCCESS The method is successful.
63 * @exception E_INVALID_ARG The specified object instances are not of the expected type.
64 * @remarks The value of @c cmp can be:
67 * < 0 if the value of @c obj1 is less than the value of @c obj2
68 * == 0 if the value of @c obj1 is equal to the value of @c obj2
69 * > 0 if the value of @c obj1 is greater than the value of @c obj2
72 virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const = 0;
75 }}} // Tizen::Base::Collection
77 #endif // _FBASE_COL_ICOMPARER_T_H_