X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFBaseColIListT.h;h=b0109fd04de48246dec4948972698751b79395d8;hb=HEAD;hp=6729b7dbcd1c92caa57b18e3b83c1fb07d48989d;hpb=60d143778a54ae4c638a08d8c7304b099f70434e;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FBaseColIListT.h b/inc/FBaseColIListT.h index 6729b7d..b0109fd 100644 --- a/inc/FBaseColIListT.h +++ b/inc/FBaseColIListT.h @@ -78,82 +78,78 @@ public: * @return An error code * @param[in] collection The collection to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: - * - The current state of the instance prohibits the execution of the specified operation. - * - The specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or + * the specified @c collection is modified during the operation of this method. * @see RemoveItems() */ virtual result AddItems(const ICollectionT< Type >& collection) = 0; /** * Searches for an object in this list. @n - * Gets the @c index of the object if found. + * Gets the index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. + * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. */ virtual result IndexOf(const Type& obj, int& index) const = 0; /** - * Searches for an object starting from the specified @c startIndex. @n - * Gets the @c index of the object if found. + * Searches for an object starting from the specified index. @n + * Gets the index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c startIndex is either greater than or equal to the number of elements in the list. - * - The specified @c startIndex is less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. + * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or + * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int& index) const = 0; /** * Searches for an object within the specified range. @n - * Gets the @c index of the object if found. + * Gets the index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c startIndex is either greater than or equal to the number of elements in the list. - * - The specified @c startIndex is less than @c 0. - * - The specified @c count is greater than the number of elements starting from @c startIndex. - * - The specified @c count is less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n + * - The specified index is outside the bounds of the data structure. @n + * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n + * - The @c count is greater than the number of elements starting from @c startIndex + * or less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const = 0; /** * Searches for the last occurrence of an object in this list. @n - * Gets the @c index of the object if found. + * Gets the index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. + * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. * @see IndexOf() */ virtual result LastIndexOf(const Type& obj, int& index) const = 0; @@ -164,14 +160,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to insert - * @param[in] index The index at which the object is inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object must be inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c index is greater than the number of elements in the list. - * - The specified @c index is less than @c 0. - * @remarks If the @c index is equal to the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or + * the @c index is greater than the number of elements in the list or less than @c 0. + * @remarks If the @c index equals the number of elements in the list, the new element * is added at the end of the list. * @see Add() * @see RemoveAt() @@ -179,21 +173,18 @@ public: virtual result InsertAt(const Type& obj, int index) = 0; /** - * Inserts the elements of a collection at the specified location in the list. + * Inserts the elements of a collection in the list at the specified location. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection is inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection must be inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c startIndex is greater than the number of elements in the list. - * - The specified @c startIndex is less than @c 0. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: - * - The current state of the instance prohibits the execution of the specified operation. - * - The specified @c collection is modified during the operation of this method. + * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or + * the @c startIndex is greater than the number of elements in the list or less than @c 0. + * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or + * the specified @c collection is modified during the operation of this method. * @remarks If the @c startIndex equals the number of elements in the list, the new elements * are added at the end of the list. * @see RemoveItems() @@ -207,13 +198,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @param[in] index The index of the object to get + * @param[out] obj The object obtained from the list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c index is either greater than or equal to the number of elements in the list. - * - The specified @c index is less than @c 0. + * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or + * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) const = 0; @@ -224,13 +213,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @param[in] index The index of the object to get + * @param[out] obj The object obtained from the list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c index is either greater than or equal to the number of elements in the list. - * - The specified @c index is less than @c 0. + * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or + * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) = 0; @@ -240,17 +227,16 @@ public: * * @since 2.0 * - * @return A pointer to %IListT that contains the elements lying within the specified range, @n + * @return A pointer to %IListT with elements lying within the specified range, @n * else @c null if an exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c startIndex is either greater than or equal to the number of elements in the list. - * - The specified @c startIndex is less than @c 0. - * - The specified @c count is greater than the number of elements in the list starting from @c startIndex. - * - The specified @c count is less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n + * - The specified index is outside the bounds of the data structure. @n + * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n + * - The @c count is greater than the number of elements in the list starting from @c startIndex + * or less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IListT< Type >* GetItemsN(int startIndex, int count) const = 0; @@ -263,7 +249,7 @@ public: * @return An error code * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. + * @exception E_OBJ_NOT_FOUND The object is not found. */ virtual result Remove(const Type& obj) = 0; @@ -273,26 +259,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object is removed + * @param[in] index The index at which the object must be removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c index is either greater than or equal to the number of elements in the list. - * - The specified @c index is less than @c 0. + * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or + * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. */ virtual result RemoveAt(int index) = 0; /** - * Removes all the elements from the list that are common to the specified @c collection. + * Removes all the elements from the list that are common to the specified collection. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: - * - The current state of the instance prohibits the execution of the specified operation. - * - The specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or + * the specified @c collection is modified during the operation of this method. * @see Remove() * @see RemoveAt() */ @@ -304,51 +287,48 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements in the range + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements in the range * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c startIndex is either greater than or equal to the number of elements in the list. - * - The specified @c startIndex is less than @c 0. - * - The specified @c count is greater than the number of elements starting from @c startIndex. - * - The specified @c count is less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n + * - The specified index is outside the bounds of the data structure. @n + * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n + * - The @c count is greater than the number of elements starting from @c startIndex + * or less than @c 0. * @see AddItems() * @see InsertItemsFrom() */ virtual result RemoveItems(int startIndex, int count) = 0; /** - * Removes all the elements from the list. + * Removes all the elements in the list. * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Sets the object at the specified @c index with the specified object. + * Sets the object at the specified index with the specified object. * * @since 2.0 * * @return An error code - * @param[in] obj The new object - * @param[in] index The index at which the new object is set + * @param[in] obj The new object + * @param[in] index The index at which the new object must be set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: - * - The specified @c index is outside the bounds of the data structure. - * - The specified @c index is either greater than or equal to the number of elements in the list. - * - The specified @c index is less than @c 0. + * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or + * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. * @see GetAt() */ virtual result SetAt(const Type& obj, int index) = 0; /** - * Sorts the elements of this list using the @c comparer provided. + * Sorts the elements of this list using the comparer provided. * * @since 2.0 * * @return An error code - * @param[in] comparer The IComparerT implementation to use when comparing the elements + * @param[in] comparer The IComparerT implementation to use when comparing elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ @@ -366,36 +346,35 @@ public: virtual bool Contains(const Type& obj) const = 0; /** - * Checks whether the list contains all the elements of the specified @c collection. + * Checks whether the list contains all the elements of the specified collection. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for containment in this list - * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n - * else @c false + * @param[in] collection The collection to check for containment in this list + * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: - * - The current state of the instance prohibits the execution of the specified operation. - * - The specified @c collection is modified during the operation of this method. - * @remarks If the given @c collection is empty, then @c out is set to @c true. + * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or + * the specified @c collection is modified during the operation of this method. + * @remarks If the given @c collection is empty, the @c out parameter is set to @c true. * @see Contains() */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const = 0; /** - * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. + * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. * * @since 2.0 * - * @return A pointer to the bidirectional enumerator interface of the %IListT derived class, @n + * @return A pointer to a bidirectional enumerator interface of the %IListT derived class, @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 - * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) - * to iterate over a collection (an instance of the %IListT derived class). - * - The specific error code can be accessed using the GetLastResult() method. + * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) + * to iterate over a collection (an instance of the %IListT derived class). + * @remarks The specific error code can be accessed using the GetLastResult() method. + * @see Tizen::Base::Collection::IBidirectionalEnumeratorT */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const = 0;