X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColIMultiMapT.h;h=41f8deaca8de389ff0b4e99ee30ac47ad5833fcb;hb=60d143778a54ae4c638a08d8c7304b099f70434e;hp=1c2a8a4fcba1817ed6f2eb7f14591070b8ca15eb;hpb=3b569ff3e66a065cb5728bc19d1da493c66f7583;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColIMultiMapT.h b/inc/FBaseColIMultiMapT.h index 1c2a8a4..41f8dea 100644 --- a/inc/FBaseColIMultiMapT.h +++ b/inc/FBaseColIMultiMapT.h @@ -38,8 +38,8 @@ template< class Type > class IListT; * * @since 2.0 * - * The %IMultiMapT interface abstracts a template-based collection of key-value pairs. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. + * The %IMultiMapT interface represents a template-based collection of key-value pairs. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. * The key and value cannot be a @c null reference. * @n * For more information on the class features, see HashMap and MultiHashMap. @@ -64,12 +64,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value already exists. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_ALREADY_EXIST The specified @c key and the specified @c value already exists. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() */ @@ -85,32 +86,34 @@ public: virtual int GetCount(void) const = 0; /** - * Gets the number of values whose key matches the specified key. + * Gets the number of values whose key matches the specified @c key. * * @since 2.0 * * @return The number of values whose key matches the specified key - * @param[in] key The key to locate in the map - * @param[out] count The number of values whose key matches the specified key + * @param[in] key The key to locate in the map + * @param[out] count The number of values whose key matches the specified key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. */ virtual result GetCount(const KeyType& key, int& count) const = 0; /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified @c key. * * @since 2.0 * - * @return An instance of the IEnumeratorT derived class with the values associated with the specified key, @n + * @return An instance of the IEnumeratorT derived class that contains the values associated with the specified key, @n * else @c null if an exception occurs * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() @@ -118,11 +121,11 @@ public: virtual IEnumeratorT< ValueType >* GetValuesN(const KeyType& key) const = 0; /** - * Gets a list of all unique keys in the map. + * Gets the list of all the unique keys in the map. * * @since 2.0 * - * @return A pointer to a list of all unique keys in the map, @n + * @return A pointer to the list of all the unique keys in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -132,11 +135,11 @@ public: virtual IListT< KeyType >* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all the values in the map, @n + * @return A pointer to the list of all the values in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -146,16 +149,17 @@ public: virtual IListT< ValueType >* GetValuesN(void) const = 0; /** - * Removes all the values associated with the specified key. + * Removes all the values associated with the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key whose associated values need to remove + * @param[in] key The key whose associated values are removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) = 0; @@ -167,12 +171,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key whose mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key, const ValueType& value) = 0; @@ -185,18 +190,19 @@ public: virtual void RemoveAll(void) = 0; /** - * Replaces the specified value associated with the specified key with a new value. + * Replaces the specified @c value associated with the specified @c key with a @c newValue. * * @since 2.0 * * @return An error code - * @param[in] key The key whose associated value needs to replace - * @param[in] value The value associated with the key - * @param[in] newValue The new value + * @param[in] key The key whose associated value is replaced + * @param[in] value The value associated with the key + * @param[in] newValue The new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks Use the Add() method to add a new key-value pair. * @see Add() @@ -210,37 +216,39 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[in] value The value to locate - * @param[out] out Set to @c true if the map contains the specified key-value pair, @n - * else @c false - * @exception E_SUCCESS The method is successful. @n - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[in] value The value to locate + * @param[out] out Set to @c true if the map contains the specified key-value pair, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsKey() * @see ContainsValue() */ virtual result Contains(const KeyType& key, const ValueType& value, bool& out) const = 0; /** - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false - * @exception E_SUCCESS The method is successful. @n - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @see Contains() */ virtual result ContainsKey(const KeyType& key, bool& out) const = 0; /** - * Checks whether the map contains the specified value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -254,17 +262,18 @@ public: virtual bool ContainsValue(const ValueType& value) const = 0; /** - * Gets an enumerator of the map. + * Gets the enumerator of the map. * * @since 2.0 * - * @return An instance of the IMapEnumeratorT class for the map, @n + * @return An instance of IMapEnumeratorT for the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks If a key has multiple values, the enumeration proceeds as follows: @n - * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - If a key has multiple values, the enumeration proceeds as follows: @n + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator * @see Tizen::Base::Collection::IMapEnumerator */