//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
#include <FBaseColIHashCodeProvider.h>
#include <FBaseColIMultiMap.h>
-
namespace Tizen { namespace Base { namespace Collection
{
* IEnumerator *pValueEnum = map.GetValuesN(String(L"Two"));
* while(pValueEnum->MoveNext() == E_SUCCESS)
* {
- * pValue = static_cast<Integer*> (pValueEnum->GetCurrent());
+ * pValue = static_cast< Integer* > (pValueEnum->GetCurrent());
* }
*
* delete pValueEnum;
* delete pMapEnum;
*
* // Deallocates all objects
- * // Because the destructor calls RemoveAll() internally, you don't need to call RemoveAll() to destroy all elements at the end.
- * map.RemoveAll();
+ * // Because the destructor calls RemoveAll() internally, you do not need to call RemoveAll() to destroy all elements at the end.
+ * // map.RemoveAll();
* }
* @endcode
*/
*
* @param[in] deleter The function pointer to type of the element deleter
* @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n
- * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
- * It means that you don't transfer the ownership of elements to the collection.
+ * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter.
+ * It means that you do not transfer the ownership of elements to the collection.
* @see NoOpDeleter()
* @see SingleObjectDeleter()
* @see ArrayDeleter()
* @param[in] loadFactor The maximum ratio of elements to buckets
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c capacity or the @c loadFactor is negative.
+ * the @c capacity or the @c loadFactor is negative.
* @remarks The GetHashCode() method of the key object is used for hashing and the
* Equals() method of the key object is used for comparing the keys.
* @see MultiHashMap()
* @param[in] comparer An instance of the IComparer derived class to use when comparing keys
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
- * the @c capacity or the @c loadFactor is negative.
+ * the @c capacity or the @c loadFactor is negative.
* @remarks The instances of hash code provider and comparer will not be deallocated later from this map.
* @see MultiHashMap()
*/
* @return An enumerator (an instance of the IEnumerator derived class) of this map, @n
* else @c null if some exception occurs
* @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
- * The specific error code can be accessed using the GetLastResult() method.
- * @see IEnumerator()
- * @see IMapEnumerator()
+ * The specific error code can be accessed using the GetLastResult() method.
+ * @see IMapEnumerator
*/
virtual IEnumerator* GetEnumeratorN(void) const;
* @return An enumerator (an instance of the IMapEnumerator derived class) of this map, @n
* else @c null if some exception occurs
* @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ...
- * The specific error code can be accessed using the GetLastResult() method.
- * @see IEnumerator()
- * @see IMapEnumerator()
+ * The specific error code can be accessed using the GetLastResult() method.
+ * @see IEnumerator
*/
virtual IMapEnumerator* GetMapEnumeratorN(void) const;
*
* @return An enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n
* else @c null if some exception occurs
- * @param[in] key A key to locate
+ * @param[in] key A 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.
virtual IEnumerator* GetValuesN(const Object& key) const;
/**
- * Gets a list of all the keys in this map.
+ * Gets a list of all unique keys in this map.
*
* @since 2.0
*
- * @return A list of all the keys in this map
- * @remarks The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method.
- * The %IList stores just the pointers to the elements in the map, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
+ * @return A list of all unique keys in this map
+ * @remarks The %IList stores just the pointers to the elements in the map, not the elements themselves.
+ * The specific error code can be accessed using the GetLastResult() method.
* @see GetValuesN()
*/
virtual IList* GetKeysN(void) const;
*
* @return A list of all the values in this map
* @remarks The IList stores just the pointers to the elements in the map, not the elements themselves.
- * The specific error code can be accessed using the GetLastResult() method.
+ * The specific error code can be accessed using the GetLastResult() method.
* @see GetKeysN()
*/
virtual IList* GetValuesN(void) const;
* @since 2.0
*
* @return An error code
- * @param[in] key The key to remove
+ * @param[in] key The key 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 keys.
* @since 2.0
*
* @return An error code
- * @param[in] key The key whose mapping is to remove from the map
+ * @param[in] key The key whose mapping is to remove 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
* @since 2.0
*
* @return An error code
- * @param[in] key The key for which the associated value needs to replace
- * @param[in] value The value to replace
+ * @param[in] key The key for which the associated value needs to replace
+ * @param[in] value The value to replace
* @param[in] pNewValue The pointer to new value to replace the existing value
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid, or
*
* @return @c true if the map contains the specified key and value pair, @n
* else @c false
- * @param[in] key The key to locate
- * @param[in] value The value to locate
+ * @param[in] key The key to locate
+ * @param[in] value The value 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.
*
* @return @c true if the map contains the specified key, @n
* else @c false
- * @param[in] key The key to locate
+ * @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.
*
* @since 2.0
*
- * @return An function pointer to the existing element deleter
+ * @return A function pointer to the existing element deleter
*/
virtual DeleterFunctionType GetDeleter(void) const;
* Copies all the pairs from the specified map to this map.
*
* @return An error code
- * @param[in] map The map to copy
+ * @param[in] map The map to copy
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n
* The @c map is modified during the operation of this method.
/**
* Rehashes the contents of this map into a new array with a
- * larger capacity.@n
+ * larger capacity. @n
* This method is called automatically when the number of keys in this map reaches its threshold.
*
* @return An error code
* @param[in] newCapacity The new capacity @n
* It must be a power of two and be greater than current capacity.
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
*/
result Resize(int newCapacity);
*
* @since 2.0
*
- * @param[in] deleter An function pointer to the element deleter to set
+ * @param[in] deleter A function pointer to the element deleter to set
*/
virtual void SetDeleter(DeleterFunctionType deleter);