//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @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
*
* @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);
* @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);
* @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);
* @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());
* @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);
* @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);
* @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);
* @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));
}
/**
- * 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));
}
/**
- * 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));
}
/**
- * 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));
// @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
projects / platform / framework / native / appfw.git / blobdiff