inc/FBaseColIMapEnumeratorT.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                FBaseColIMapEnumeratorT.h
  19  * @brief               This is the header file for the %IMapEnumeratorT interface.
  20  *
  21  * This header file contains the declarations of the %IMapEnumeratorT interface.
  22  */
  23 #ifndef _FBASE_COL_IMAP_ENUMERATOR_T_H_
  24 #define _FBASE_COL_IMAP_ENUMERATOR_T_H_
  25
  26 #include <FBaseColIEnumeratorT.h>
  27 #include <FBaseColMapEntryT.h>
  28
  29 namespace Tizen { namespace Base { namespace Collection
  30 {
  31
  32 /**
  33  * @interface   IMapEnumeratorT
  34  * @brief               This interface supports simple iteration over a template-based map. @n
  35  *                              Using this method, you can only access the elements in the map. You cannot modify the elements.
  36  *
  37  * @since 2.0
  38  *
  39  * @remarks
  40  * An enumerator remains valid as long as the map remains unchanged.
  41  * If changes are made to the map, such as adding, modifying, or
  42  * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an @c E_INVALID_OPERATION message.
  43  *
  44  * The %IMapEnumeratorT interface supports simple iteration over a template-based map.
  45  * Using this method, you can only access the elements in the map. You cannot modify the elements.
  46  *
  47  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/hashmap_multihashmap.htm">HashMap and MultiHashMap</a>.
  48  *
  49  */
  50 template< class KeyType, class ValueType >
  51 class IMapEnumeratorT
  52         : public virtual IEnumeratorT< MapEntryT< KeyType, ValueType > >
  53 {
  54 public:
  55         /**
  56          * This polymorphic destructor should be overridden if required. @n
  57          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  58          *
  59          * @since 2.0
  60          */
  61         virtual ~IMapEnumeratorT(void) {}
  62
  63         /**
  64          * Gets the current key in the map.
  65          *
  66          * @since 2.0
  67          *
  68          * @return              An error code
  69          * @param[out]  key                             The current key
  70          * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation. @n
  71          *                                                                      The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created.
  72          * @exception   E_SUCCESS                       The method is successful.
  73          */
  74         virtual result GetKey(KeyType& key) const = 0;
  75
  76         /**
  77          * Gets the current value in the map.
  78          *
  79          * @since 2.0
  80          *
  81          * @return              An error code
  82          * @param[out]  value                           The current value
  83          * @exception   E_INVALID_OPERATION     The current state of the instance prohibits the execution of the specified operation. @n
  84          *                                                                      The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created.
  85          * @exception   E_SUCCESS                       The method is successful.
  86          */
  87         virtual result GetValue(ValueType& value) const = 0;
  88
  89 }; // IMapEnumeratorT
  90
  91 }}} // Tizen::Base::Collection
  92
  93 #endif // _FBASE_COL_IMAP_ENUMERATOR_H_