/**
* @interface IMapT
- * @brief This interface abstracts a template-based collection of key-value pairs.
+ * @brief This interface represents a template-based collection of key-value pairs.
*
* @since 2.0
*
- * The %IMapT interface abstracts a template-based collection of key-value pairs. An %IMapT
+ * The %IMapT interface represents a template-based collection of key-value pairs. An %IMapT
* contains unique keys and each key maps to a single value.
* The key and value cannot be a @c null reference.
*
* @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_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 already exists.
* @see Remove()
*/
virtual result Add(const KeyType& key, const ValueType& value) = 0;
/**
- * Gets the value associated with the specified @c key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
- * @return The value associated with the specified @c key, @n
+ * @return The value associated to the specified key, @n
* else @c null if an exception occurs
- * @param[in] key The key to find the associated value
- * @param[out] value The value associated with the key
+ * @param[in] key The key used to find the associated value
+ * @param[out] value The value associated to the 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.
* @see SetValue()
*/
virtual result GetValue(const KeyType& key, ValueType& value) const = 0;
/**
- * Gets the value associated with the specified @c key.
+ * Gets the value associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key to find the associated value
- * @param[out] value The value associated with the key
+ * @param[in] key The key used to find the associated value
+ * @param[out] value The value associated to the 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.
* @see SetValue()
*/
virtual result GetValue(const KeyType& key, ValueType& value) = 0;
/**
- * Gets a list of all the keys in the map.
+ * Gets the list of all the keys in the map.
*
* @since 2.0
*
- * @return A pointer to a list of all the keys in the map, @n
+ * @return A pointer to the list of all the 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.
- * @remarks The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see GetValuesN()
+ * @remarks
+ * - The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
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 values in the map, @n
+ * @return A pointer to the list of all 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.
virtual IListT< ValueType >* GetValuesN(void) const = 0;
/**
- * Removes the value associated with the specified @c key.
+ * Removes the value associated to the specified @c key.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the value is to remove
+ * @param[in] key The key for which the value is 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:
+ * - The 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;
/**
- * Removes all key-value pairs in the map.
+ * Removes all the key-value pairs in the map.
*
* @since 2.0
*/
virtual void RemoveAll(void) = 0;
/**
- * Replaces the value associated with the specified @c key with the specified @c value.
+ * Replaces the value associated to the specified @c key with the specified @c value.
*
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose value is to replace
- * @param[in] value The new value
+ * @param[in] key The key whose value is replaced
+ * @param[in] value 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 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.
* @remarks Use the Add() method to add a new key-value pair.
- * @see Add()
* @see GetValue()
*/
virtual result SetValue(const KeyType& key, const ValueType& value) = 0;
* @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 @c key, @n
- * else @c false
- * @exception E_SUCCESS The method is successful, or
- * the map contains the specified @c key.
- * @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 The boolean value that indicates if the map contains the specified @c key
+ * @exception E_SUCCESS Either of the following conditions has occurred:
+ * - The method is successful.
+ * - The map contains the specified @c key.
+ * @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()
*/
virtual result ContainsKey(const KeyType& key, bool& out) const = 0;
*
* @since 2.0
*
- * @return @c true if the map contains the specified @c value, @n
+ * @return @c true if the map contains the specified value, @n
* else @c false
* @param[in] value The value to locate
*
virtual bool ContainsValue(const ValueType& value) const = 0;
/**
- * Gets an instance of the IMapEnumeratorT class for the map.
+ * Gets an instance of IMapEnumeratorT for the map.
*
* @since 2.0
*
- * @return An object of this map, @n
+ * @return An instance of IMapEnumeratorT for this 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.
projects / platform / framework / native / appfw.git / blobdiff