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 FBaseColMapEntryT.h
19 * @brief This is the header file for the %MapEntryT class.
21 * This header file contains the declarations of the %MapEntryT class.
23 #ifndef _FBASE_COL_MAP_ENTRY_T_H_
24 #define _FBASE_COL_MAP_ENTRY_T_H_
26 #include <FBaseObject.h>
29 namespace Tizen { namespace Base { namespace Collection
34 * @brief This class represents a template-based key-value pair.
38 * The %MapEntryT class represents a template-based key-value pair.
40 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/mapentry.htm">MapEntry</a>.
43 template< class KeyType, class ValueType >
45 : public Tizen::Base::Object
49 * This is the default constructor for this class.
60 * Initializes this instance of %MapEntryT with the specified key-value pair.
64 * @param[in] key The key for this mapping
65 * @param[in] value The value for this mapping
67 MapEntryT(const KeyType& key, const ValueType& value)
75 * This destructor overrides Tizen::Base::Object::~Object().
79 virtual ~MapEntryT(void)
85 * Copying of objects using this copy assignment operator is allowed.
89 * @param[in] entry An instance of %MapEntryT
91 MapEntryT< KeyType, ValueType >& operator =(const MapEntryT< KeyType, ValueType >& entry)
103 * Gets the key corresponding to this entry.
107 * @return The key corresponding to this entry
110 virtual const KeyType& GetKey(void) const
116 * Gets the value corresponding to this entry.
120 * @return The value corresponding to this entry
123 virtual const ValueType& GetValue(void) const
129 * Gets the hash value of the current instance.
133 * @return The hash value of the current instance
134 * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n
135 * the used hash function must generate a random distribution for all inputs.
137 virtual int GetHashCode(void) const
140 hash += reinterpret_cast< int >(&__key);
141 hash += reinterpret_cast< int >(&__val);
151 }}} // Tizen::Base::Collection
153 #endif // _FBASE_COL_MAP_ENTRY_T_H_