X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColStlConverter.h;h=5b65d1f94a39b42bd6472a9f8c04c44947380870;hb=42786f79805fb29e4d73e9527b0e02391815fc9a;hp=24a5ba3f759a347ce91c56ac54a0fd1d50b0f223;hpb=2dde6926bae04f855fd63b6358f01eeb862c7126;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColStlConverter.h b/inc/FBaseColStlConverter.h index 24a5ba3..5b65d1f 100644 --- a/inc/FBaseColStlConverter.h +++ b/inc/FBaseColStlConverter.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2013 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -44,7 +43,7 @@ class IMultiMap; /** * @class StlConverter - * @brief This class provides static methods to convert %Tizen Collection to STL Container and vice versa. + * @brief This class provides static methods to convert %Tizen %Collection to STL Container and vice versa. * * @since 2.1 * @@ -98,7 +97,7 @@ public: * @return An IteratorT instance * @param[in] pList A pointer to the IList instance to convert */ - template < typename T > + template< typename T > static IteratorT< T > GetBeginIterator(const IList* pList) { return IteratorT< T >(*pList); @@ -112,7 +111,7 @@ public: * @return An IteratorT instance * @param[in] pList A pointer to the IList instance to convert */ - template < typename T > + template< typename T > static IteratorT< T > GetEndIterator(const IList* pList) { return IteratorT< T >(*pList, true); @@ -126,7 +125,7 @@ public: * @return A RandomIteratorT instance * @param[in] pList A pointer to the IList instance to convert */ - template < typename T > + template< typename T > static RandomIteratorT< T > GetBeginRandomIterator(const IList* pList) { return RandomIteratorT< T >(*pList, 0); @@ -140,7 +139,7 @@ public: * @return A RandomIteratorT instance * @param[in] pList A pointer to the IList instance to convert */ - template < typename T > + template< typename T > static RandomIteratorT< T > GetEndRandomIterator(const IList* pList) { return RandomIteratorT< T >(*pList, pList->GetCount()); @@ -155,7 +154,7 @@ public: * @return A PairIteratorT instance * @param[in] pMap A pointer to the IMap instance to convert */ - template < typename K, typename V > + template< typename K, typename V > static PairIteratorT< K, V > GetBeginPairIterator(const IMap* pMap) { return PairIteratorT< K, V >(*pMap); @@ -170,7 +169,7 @@ public: * @return A PairIteratorT instance * @param[in] pMap A pointer to the IMap instance to convert */ - template < typename K, typename V > + template< typename K, typename V > static PairIteratorT< K, V > GetEndPairIterator(const IMap* pMap) { return PairIteratorT< K, V >(*pMap, true); @@ -185,7 +184,7 @@ public: * @return A PairIteratorT instance * @param[in] pMultiMap A pointer to the IMultiMap instance to convert */ - template < typename K, typename V > + template< typename K, typename V > static PairIteratorT< K, V > GetBeginPairIterator(const IMultiMap* pMultiMap) { return PairIteratorT< K, V >(*pMultiMap); @@ -200,35 +199,36 @@ public: * @return A PairIteratorT instance * @param[in] pMultiMap A pointer to the IMultiMap instance to convert */ - template < typename K, typename V > + template< typename K, typename V > static PairIteratorT< K, V > GetEndPairIterator(const IMultiMap* pMultiMap) { return PairIteratorT< K, V >(*pMultiMap, true); } /** - * Gets an ArrayList instance from the begin and end iterators of STL container. + * Gets an ArrayList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the ArrayList instance, @n - * else @c std::unique_ptr< ArrayList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< ArrayList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection can 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. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() */ - template < typename FwdIter > + template< typename FwdIter > static std::unique_ptr< ArrayList > GetArrayListN(FwdIter begin, FwdIter end, DeleterFunctionType deleter = NoOpDeleter) { std::unique_ptr< ArrayList > pArrayList(new (std::nothrow) ArrayList(deleter)); @@ -251,28 +251,29 @@ public: } /** - * Gets a LinkedList instance from the begin and end iterators of STL container. + * Gets a LinkedList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the LinkedList instance @n - * else @c std::unique_ptr< LinkedList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< LinkedList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning 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. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() */ - template < typename FwdIter > + template< typename FwdIter > static std::unique_ptr< LinkedList > GetLinkedListN(FwdIter begin, FwdIter end, DeleterFunctionType deleter = NoOpDeleter) { std::unique_ptr< LinkedList > pLinkedList(new (std::nothrow) LinkedList(deleter)); @@ -292,28 +293,29 @@ public: } /** - * Gets a HashMap instance from the begin and end iterators of STL container. + * Gets a HashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the HashMap instance @n - * else @c std::unique_ptr< HashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< HashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning 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. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() */ - template < typename PairedFwdIter > + template< typename PairedFwdIter > static std::unique_ptr< HashMap > GetHashMapN(PairedFwdIter begin, PairedFwdIter end, DeleterFunctionType deleter = NoOpDeleter) { std::unique_ptr< HashMap > pMap(new (std::nothrow) HashMap(deleter)); @@ -336,28 +338,29 @@ public: } /** - * Gets a MultiHashMap instance from the begin and end iterators of STL container. + * Gets a MultiHashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the MultiHashMap instance @n - * else @c std::unique_ptr< MultiHashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< MultiHashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning 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. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() */ - template < typename PairedFwdIter > + template< typename PairedFwdIter > static std::unique_ptr< MultiHashMap > GetMultiHashMapN(PairedFwdIter begin, PairedFwdIter end, DeleterFunctionType deleter = NoOpDeleter) { std::unique_ptr< MultiHashMap > pMultiMap(new (std::nothrow) MultiHashMap(deleter)); @@ -411,7 +414,7 @@ private: // @return A reference to the %StlConverter instance // @param[in] rhs A reference to the %StlConverter instance // - StlConverter& operator=(const StlConverter& rhs); + StlConverter& operator =(const StlConverter& rhs); }; }}} // Tizen::Base::Collection